lib/twilio-ruby/rest/ip_messaging/v2/service.rb in twilio-ruby-5.25.4 vs lib/twilio-ruby/rest/ip_messaging/v2/service.rb in twilio-ruby-5.26.0
- old
+ new
@@ -161,12 +161,11 @@
class ServiceContext < InstanceContext
##
# Initialize the ServiceContext
# @param [Version] version Version that contains the resource
- # @param [String] sid The Twilio-provided string that uniquely identifies the
- # Service resource to fetch.
+ # @param [String] sid The SID of the Service resource to fetch.
# @return [ServiceContext] ServiceContext
def initialize(version, sid)
super(version)
# Path Solution
@@ -195,28 +194,28 @@
ServiceInstance.new(@version, payload, sid: @solution[:sid], )
end
##
# Deletes the ServiceInstance
- # @return [Boolean] true if delete succeeds, true otherwise
+ # @return [Boolean] true if delete succeeds, false otherwise
def delete
@version.delete('delete', @uri)
end
##
# Update the ServiceInstance
# @param [String] friendly_name A descriptive string that you create to describe
# the resource.
# @param [String] default_service_role_sid The service role assigned to users when
- # they are added to the service. See the [Roles
- # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
+ # they are added to the service. See the [Role
+ # resource](https://www.twilio.com/docs/chat/api/roles) for more info about roles.
# @param [String] default_channel_role_sid The channel role assigned to users when
- # they are added to a channel. See the [Roles
- # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
+ # they are added to a channel. See the [Role
+ # resource](https://www.twilio.com/docs/chat/api/roles) for more info about roles.
# @param [String] default_channel_creator_role_sid The channel role assigned to a
- # channel creator when they join a new channel. See the [Roles
- # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
+ # channel creator when they join a new channel. See the [Role
+ # resource](https://www.twilio.com/docs/chat/api/roles) for more info about roles.
# @param [Boolean] read_status_enabled Whether to enable the [Message Consumption
# Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The
# default is `true`.
# @param [Boolean] reachability_enabled Whether to enable the [Reachability
# Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this
@@ -225,41 +224,38 @@
# typing` event until clients should assume that user is no longer typing, even if
# no `ended typing` message was received. The default is 5 seconds.
# @param [String] consumption_report_interval DEPRECATED. The interval in seconds
# between consumption reports submission batches from client endpoints.
# @param [Boolean] notifications_new_message_enabled Whether to send a
- # notification when a new message is added to a channel. Can be: `true` or `false`
- # and the default is `false`.
+ # notification when a new message is added to a channel. The default is `false`.
# @param [String] notifications_new_message_template The template to use to create
# the notification text displayed when a new message is added to a channel and
# `notifications.new_message.enabled` is `true`.
# @param [String] notifications_new_message_sound The name of the sound to play
# when a new message is added to a channel and `notifications.new_message.enabled`
# is `true`.
# @param [Boolean] notifications_new_message_badge_count_enabled Whether the new
- # message badge is enabled. Can be: `true` or `false` and the default is `false`.
+ # message badge is enabled. The default is `false`.
# @param [Boolean] notifications_added_to_channel_enabled Whether to send a
- # notification when a member is added to a channel. Can be: `true` or `false` and
- # the default is `false`.
+ # notification when a member is added to a channel. The default is `false`.
# @param [String] notifications_added_to_channel_template The template to use to
# create the notification text displayed when a member is added to a channel and
# `notifications.added_to_channel.enabled` is `true`.
# @param [String] notifications_added_to_channel_sound The name of the sound to
# play when a member is added to a channel and
# `notifications.added_to_channel.enabled` is `true`.
# @param [Boolean] notifications_removed_from_channel_enabled Whether to send a
- # notification to a user when they are removed from a channel. Can be: `true` or
- # `false` and the default is `false`.
+ # notification to a user when they are removed from a channel. The default is
+ # `false`.
# @param [String] notifications_removed_from_channel_template The template to use
# to create the notification text displayed to a user when they are removed from a
# channel and `notifications.removed_from_channel.enabled` is `true`.
# @param [String] notifications_removed_from_channel_sound The name of the sound
# to play to a user when they are removed from a channel and
# `notifications.removed_from_channel.enabled` is `true`.
# @param [Boolean] notifications_invited_to_channel_enabled Whether to send a
- # notification when a user is invited to a channel. Can be: `true` or `false` and
- # the default is `false`.
+ # notification when a user is invited to a channel. The default is `false`.
# @param [String] notifications_invited_to_channel_template The template to use to
# create the notification text displayed when a user is invited to a channel and
# `notifications.invited_to_channel.enabled` is `true`.
# @param [String] notifications_invited_to_channel_sound The name of the sound to
# play when a user is invited to a channel and
@@ -272,11 +268,11 @@
# Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
# @param [String] webhook_method The HTTP method to use for calls to the
# `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and
# the default is `POST`. See [Webhook
# Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
- # @param [String] webhook_filters The list of WebHook events that are enabled for
+ # @param [String] webhook_filters The list of webhook events that are enabled for
# this Service instance. See [Webhook
# Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
# @param [String] limits_channel_members The maximum number of Members that can be
# added to Channels within this Service. Can be up to 1,000.
# @param [String] limits_user_channels The maximum number of Channels Users can be
@@ -289,12 +285,12 @@
# the call won't be retried.
# @param [String] post_webhook_retry_count The number of times to retry a call to
# the `post_webhook_url` if the request times out (after 5 seconds) or it receives
# a 429, 503, or 504 HTTP response. The default is 0, which means the call won't
# be retried.
- # @param [Boolean] notifications_log_enabled Whether to log notifications. Can be:
- # `true` or `false` and the default is `false`.
+ # @param [Boolean] notifications_log_enabled Whether to log notifications. The
+ # default is `false`.
# @return [ServiceInstance] Updated ServiceInstance
def update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_new_message_sound: :unset, notifications_new_message_badge_count_enabled: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_added_to_channel_sound: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_removed_from_channel_sound: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, notifications_invited_to_channel_sound: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, limits_channel_members: :unset, limits_user_channels: :unset, media_compatibility_message: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset, notifications_log_enabled: :unset)
data = Twilio::Values.of({
'FriendlyName' => friendly_name,
'DefaultServiceRoleSid' => default_service_role_sid,
@@ -428,12 +424,11 @@
class ServiceInstance < InstanceResource
##
# Initialize the ServiceInstance
# @param [Version] version Version that contains the resource
# @param [Hash] payload payload that contains response from Twilio
- # @param [String] sid The Twilio-provided string that uniquely identifies the
- # Service resource to fetch.
+ # @param [String] sid The SID of the Service resource to fetch.
# @return [ServiceInstance] ServiceInstance
def initialize(version, payload, sid: nil)
super(version)
# Marshaled Properties
@@ -574,11 +569,11 @@
def webhook_method
@properties['webhook_method']
end
##
- # @return [String] The list of WebHook events that are enabled for this Service instance
+ # @return [String] The list of webhook events that are enabled for this Service instance
def webhook_filters
@properties['webhook_filters']
end
##
@@ -624,28 +619,28 @@
context.fetch
end
##
# Deletes the ServiceInstance
- # @return [Boolean] true if delete succeeds, true otherwise
+ # @return [Boolean] true if delete succeeds, false otherwise
def delete
context.delete
end
##
# Update the ServiceInstance
# @param [String] friendly_name A descriptive string that you create to describe
# the resource.
# @param [String] default_service_role_sid The service role assigned to users when
- # they are added to the service. See the [Roles
- # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
+ # they are added to the service. See the [Role
+ # resource](https://www.twilio.com/docs/chat/api/roles) for more info about roles.
# @param [String] default_channel_role_sid The channel role assigned to users when
- # they are added to a channel. See the [Roles
- # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
+ # they are added to a channel. See the [Role
+ # resource](https://www.twilio.com/docs/chat/api/roles) for more info about roles.
# @param [String] default_channel_creator_role_sid The channel role assigned to a
- # channel creator when they join a new channel. See the [Roles
- # endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
+ # channel creator when they join a new channel. See the [Role
+ # resource](https://www.twilio.com/docs/chat/api/roles) for more info about roles.
# @param [Boolean] read_status_enabled Whether to enable the [Message Consumption
# Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The
# default is `true`.
# @param [Boolean] reachability_enabled Whether to enable the [Reachability
# Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this
@@ -654,41 +649,38 @@
# typing` event until clients should assume that user is no longer typing, even if
# no `ended typing` message was received. The default is 5 seconds.
# @param [String] consumption_report_interval DEPRECATED. The interval in seconds
# between consumption reports submission batches from client endpoints.
# @param [Boolean] notifications_new_message_enabled Whether to send a
- # notification when a new message is added to a channel. Can be: `true` or `false`
- # and the default is `false`.
+ # notification when a new message is added to a channel. The default is `false`.
# @param [String] notifications_new_message_template The template to use to create
# the notification text displayed when a new message is added to a channel and
# `notifications.new_message.enabled` is `true`.
# @param [String] notifications_new_message_sound The name of the sound to play
# when a new message is added to a channel and `notifications.new_message.enabled`
# is `true`.
# @param [Boolean] notifications_new_message_badge_count_enabled Whether the new
- # message badge is enabled. Can be: `true` or `false` and the default is `false`.
+ # message badge is enabled. The default is `false`.
# @param [Boolean] notifications_added_to_channel_enabled Whether to send a
- # notification when a member is added to a channel. Can be: `true` or `false` and
- # the default is `false`.
+ # notification when a member is added to a channel. The default is `false`.
# @param [String] notifications_added_to_channel_template The template to use to
# create the notification text displayed when a member is added to a channel and
# `notifications.added_to_channel.enabled` is `true`.
# @param [String] notifications_added_to_channel_sound The name of the sound to
# play when a member is added to a channel and
# `notifications.added_to_channel.enabled` is `true`.
# @param [Boolean] notifications_removed_from_channel_enabled Whether to send a
- # notification to a user when they are removed from a channel. Can be: `true` or
- # `false` and the default is `false`.
+ # notification to a user when they are removed from a channel. The default is
+ # `false`.
# @param [String] notifications_removed_from_channel_template The template to use
# to create the notification text displayed to a user when they are removed from a
# channel and `notifications.removed_from_channel.enabled` is `true`.
# @param [String] notifications_removed_from_channel_sound The name of the sound
# to play to a user when they are removed from a channel and
# `notifications.removed_from_channel.enabled` is `true`.
# @param [Boolean] notifications_invited_to_channel_enabled Whether to send a
- # notification when a user is invited to a channel. Can be: `true` or `false` and
- # the default is `false`.
+ # notification when a user is invited to a channel. The default is `false`.
# @param [String] notifications_invited_to_channel_template The template to use to
# create the notification text displayed when a user is invited to a channel and
# `notifications.invited_to_channel.enabled` is `true`.
# @param [String] notifications_invited_to_channel_sound The name of the sound to
# play when a user is invited to a channel and
@@ -701,11 +693,11 @@
# Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
# @param [String] webhook_method The HTTP method to use for calls to the
# `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and
# the default is `POST`. See [Webhook
# Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
- # @param [String] webhook_filters The list of WebHook events that are enabled for
+ # @param [String] webhook_filters The list of webhook events that are enabled for
# this Service instance. See [Webhook
# Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
# @param [String] limits_channel_members The maximum number of Members that can be
# added to Channels within this Service. Can be up to 1,000.
# @param [String] limits_user_channels The maximum number of Channels Users can be
@@ -718,11 +710,11 @@
# the call won't be retried.
# @param [String] post_webhook_retry_count The number of times to retry a call to
# the `post_webhook_url` if the request times out (after 5 seconds) or it receives
# a 429, 503, or 504 HTTP response. The default is 0, which means the call won't
# be retried.
- # @param [Boolean] notifications_log_enabled Whether to log notifications. Can be:
- # `true` or `false` and the default is `false`.
+ # @param [Boolean] notifications_log_enabled Whether to log notifications. The
+ # default is `false`.
# @return [ServiceInstance] Updated ServiceInstance
def update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_new_message_sound: :unset, notifications_new_message_badge_count_enabled: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_added_to_channel_sound: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_removed_from_channel_sound: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, notifications_invited_to_channel_sound: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, limits_channel_members: :unset, limits_user_channels: :unset, media_compatibility_message: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset, notifications_log_enabled: :unset)
context.update(
friendly_name: friendly_name,
default_service_role_sid: default_service_role_sid,
\ No newline at end of file