twilio-ruby 5.9.0 → 5.10.0

data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb

@@ -15,7 +15,9 @@ module Twilio
             ##
             # Initialize the RoleList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The unique id of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services) this role
+            #   belongs to.
             # @return [RoleList] RoleList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,9 +30,13 @@ module Twilio
             ##
             # Retrieve a single page of RoleInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [role.RoleType] type The type
-            # @param [String] permission The permission
+            # @param [String] friendly_name The human-readable name of this role.
+            # @param [role.RoleType] type What kind of role this is. Either `channel` for
+            #   [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channel) roles or
+            #   `deployment` for
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services) roles.
+            # @param [String] permission (multiple) A permission this role should have.
+            #   Consult the table above for the list of possible permissions.
             # @return [RoleInstance] Newly created RoleInstance
             def create(friendly_name: nil, type: nil, permission: nil)
               data = Twilio::Values.of({
@@ -205,7 +211,8 @@ module Twilio
 
             ##
             # Update the RoleInstance
-            # @param [String] permission The permission
+            # @param [String] permission (multiple) A permission this role should have.
+            #   Consult the table above for the list of possible permissions.
             # @return [RoleInstance] Updated RoleInstance
             def update(permission: nil)
               data = Twilio::Values.of({'Permission' => Twilio.serialize_list(permission) { |e| e }, })
@@ -232,7 +239,9 @@ module Twilio
             # Initialize the RoleInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The unique id of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services) this role
+            #   belongs to.
             # @param [String] sid The sid
             # @return [RoleInstance] RoleInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
@@ -268,55 +277,55 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] A 34 character string that uniquely identifies this resource.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The unique id of the Account responsible for this role.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The unique id of the Service this role belongs to.
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The human-readable name of this role.
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [role.RoleType] The type
+            # @return [role.RoleType] What kind of role this is.
             def type
               @properties['type']
             end
 
             ##
-            # @return [String] The permissions
+            # @return [String] A JSON array of the permissions this role has.
             def permissions
               @properties['permissions']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date that this resource was created in ISO 8601 format.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date that this resource was last updated in ISO 8601 format.
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] An absolute URL for this role.
             def url
               @properties['url']
             end
@@ -337,7 +346,8 @@ module Twilio
 
             ##
             # Update the RoleInstance
-            # @param [String] permission The permission
+            # @param [String] permission (multiple) A permission this role should have.
+            #   Consult the table above for the list of possible permissions.
             # @return [RoleInstance] Updated RoleInstance
             def update(permission: nil)
               context.update(permission: permission, )

data/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb

@@ -17,7 +17,8 @@ module Twilio
               # Initialize the UserChannelList
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The service_sid
-              # @param [String] user_sid The sid
+              # @param [String] user_sid A 34 character string that uniquely identifies this
+              #   resource.
               # @return [UserChannelList] UserChannelList
               def initialize(version, service_sid: nil, user_sid: nil)
                 super(version)
@@ -156,7 +157,8 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] service_sid The service_sid
-              # @param [String] user_sid The sid
+              # @param [String] user_sid A 34 character string that uniquely identifies this
+              #   resource.
               # @return [UserChannelInstance] UserChannelInstance
               def initialize(version, payload, service_sid: nil, user_sid: nil)
                 super(version)

data/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb

@@ -15,7 +15,9 @@ module Twilio
             ##
             # Initialize the UserList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The unique id of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services) this user
+            #   belongs to.
             # @return [UserList] UserList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,10 +30,17 @@ module Twilio
             ##
             # Retrieve a single page of UserInstance records from the API.
             # Request is executed immediately.
-            # @param [String] identity The identity
-            # @param [String] role_sid The role_sid
-            # @param [String] attributes The attributes
-            # @param [String] friendly_name The friendly_name
+            # @param [String] identity A unique string that identifies the user within this
+            #   service - often a username or email address. See the [identity][identity] docs
+            #   for more details.
+            # @param [String] role_sid The unique id of the
+            #   [Role](https://www.twilio.com/docs/api/chat/rest/v1/roles) assigned to this
+            #   user.
+            # @param [String] attributes An optional string used to contain any metadata or
+            #   other information for the User.  The string must contain structurally valid JSON
+            #   if specified.
+            # @param [String] friendly_name An optional human readable string representing the
+            #   user.  Often used for display purposes.
             # @return [UserInstance] Newly created UserInstance
             def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset)
               data = Twilio::Values.of({
@@ -210,9 +219,13 @@ module Twilio
 
             ##
             # Update the UserInstance
-            # @param [String] role_sid The role_sid
-            # @param [String] attributes The attributes
-            # @param [String] friendly_name The friendly_name
+            # @param [String] role_sid The unique id of the [Role][role] assigned to this
+            #   user.
+            # @param [String] attributes An optional string used to contain any metadata or
+            #   other information for the User.  The string must contain structurally valid JSON
+            #   if specified.
+            # @param [String] friendly_name An optional human readable string representing the
+            #   user.  Often used for display purposes.
             # @return [UserInstance] Updated UserInstance
             def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
               data = Twilio::Values.of({
@@ -259,7 +272,9 @@ module Twilio
             # Initialize the UserInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The unique id of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services) this user
+            #   belongs to.
             # @param [String] sid The sid
             # @return [UserInstance] UserInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
@@ -300,67 +315,67 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] A 34 character string that uniquely identifies this resource.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The unique id of the Account responsible for this user.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The unique id of the Service this user belongs to.
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The attributes
+            # @return [String] An optional string metadata field you can use to store any data you wish.
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The human-readable name of this user.
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The role_sid
+            # @return [String] The unique id of the [Role][role] assigned to this user.
             def role_sid
               @properties['role_sid']
             end
 
             ##
-            # @return [String] The identity
+            # @return [String] A unique string that identifies the user within this service - often a username or email address.
             def identity
               @properties['identity']
             end
 
             ##
-            # @return [Boolean] The is_online
+            # @return [Boolean] Indicates whether the User is actively connected to the Service instance and online.
             def is_online
               @properties['is_online']
             end
 
             ##
-            # @return [Boolean] The is_notifiable
+            # @return [Boolean] Indicates whether the User has a potentially valid Push Notification registration  for the Service instance.
             def is_notifiable
               @properties['is_notifiable']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date that this resource was created in ISO 8601 format.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date that this resource was last updated in ISO 8601 format.
             def date_updated
               @properties['date_updated']
             end
@@ -378,7 +393,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The url
+            # @return [String] An absolute URL for this user.
             def url
               @properties['url']
             end
@@ -399,9 +414,13 @@ module Twilio
 
             ##
             # Update the UserInstance
-            # @param [String] role_sid The role_sid
-            # @param [String] attributes The attributes
-            # @param [String] friendly_name The friendly_name
+            # @param [String] role_sid The unique id of the [Role][role] assigned to this
+            #   user.
+            # @param [String] attributes An optional string used to contain any metadata or
+            #   other information for the User.  The string must contain structurally valid JSON
+            #   if specified.
+            # @param [String] friendly_name An optional human readable string representing the
+            #   user.  Often used for display purposes.
             # @return [UserInstance] Updated UserInstance
             def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
               context.update(role_sid: role_sid, attributes: attributes, friendly_name: friendly_name, )

data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb

@@ -26,7 +26,7 @@ module Twilio
           ##
           # Retrieve a single page of ServiceInstance records from the API.
           # Request is executed immediately.
-          # @param [String] friendly_name The friendly_name
+          # @param [String] friendly_name Human-readable name for this service instance
           # @return [ServiceInstance] Newly created ServiceInstance
           def create(friendly_name: nil)
             data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -201,15 +201,22 @@ module Twilio
 
           ##
           # Update the ServiceInstance
-          # @param [String] friendly_name The friendly_name
+          # @param [String] friendly_name Human-readable name for this service instance
           # @param [String] default_service_role_sid The default_service_role_sid
-          # @param [String] default_channel_role_sid The default_channel_role_sid
-          # @param [String] default_channel_creator_role_sid The
-          #   default_channel_creator_role_sid
-          # @param [Boolean] read_status_enabled The read_status_enabled
-          # @param [Boolean] reachability_enabled The reachability_enabled
-          # @param [String] typing_indicator_timeout The typing_indicator_timeout
-          # @param [String] consumption_report_interval The consumption_report_interval
+          # @param [String] default_channel_role_sid Channel role assigned on channel join
+          #   (see [Roles](https://www.twilio.com/docs/api/chat/rest/v1/roles) data model for
+          #   the details)
+          # @param [String] default_channel_creator_role_sid Channel role assigned to
+          #   creator of channel when joining for first time
+          # @param [Boolean] read_status_enabled `true` if the member read status feature is
+          #   enabled, `false` if not.  Defaults to `true`.
+          # @param [Boolean] reachability_enabled `true` if the reachability feature should
+          #   be enabled.  Defaults to `false`
+          # @param [String] typing_indicator_timeout ISO 8601 duration indicating the
+          #   timeout after "started typing" event when client should assume that user is not
+          #   typing anymore even if no "ended typing" message received
+          # @param [String] consumption_report_interval ISO 8601 duration indicating the
+          #   interval between consumption reports sent from client endpoints.
           # @param [Boolean] notifications_new_message_enabled The
           #   notifications.new_message.enabled
           # @param [String] notifications_new_message_template The
@@ -226,10 +233,18 @@ module Twilio
           #   notifications.invited_to_channel.enabled
           # @param [String] notifications_invited_to_channel_template The
           #   notifications.invited_to_channel.template
-          # @param [String] pre_webhook_url The pre_webhook_url
-          # @param [String] post_webhook_url The post_webhook_url
-          # @param [String] webhook_method The webhook_method
-          # @param [String] webhook_filters The webhook_filters
+          # @param [String] pre_webhook_url The webhook URL for PRE-Event webhooks. See
+          #   [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more
+          #   details.
+          # @param [String] post_webhook_url The webhook URL for POST-Event webhooks. See
+          #   [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more
+          #   details.
+          # @param [String] webhook_method The webhook request format to use.  Must be POST
+          #   or GET. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for
+          #   more details.
+          # @param [String] webhook_filters The list of WebHook events that are enabled for
+          #   this Service instance. See [Webhook
+          #   Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.
           # @param [String] webhooks_on_message_send_url The webhooks.on_message_send.url
           # @param [String] webhooks_on_message_send_method The
           #   webhooks.on_message_send.method
@@ -517,73 +532,73 @@ module Twilio
           end
 
           ##
-          # @return [String] The sid
+          # @return [String] A 34 character string that uniquely identifies this resource.
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] The account_sid
+          # @return [String] The unique id of the Account responsible for this service.
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The friendly_name
+          # @return [String] The human-readable name of this service.
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [Time] The date_created
+          # @return [Time] The date that this resource was created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date_updated
+          # @return [Time] The date that this resource was last updated
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The default_service_role_sid
+          # @return [String] The service role assigned to users when they are added to the service.
           def default_service_role_sid
             @properties['default_service_role_sid']
           end
 
           ##
-          # @return [String] The default_channel_role_sid
+          # @return [String] The channel role assigned to users when they are added to a channel.
           def default_channel_role_sid
             @properties['default_channel_role_sid']
           end
 
           ##
-          # @return [String] The default_channel_creator_role_sid
+          # @return [String] The channel role assigned to a channel creator when joining a new channel.
           def default_channel_creator_role_sid
             @properties['default_channel_creator_role_sid']
           end
 
           ##
-          # @return [Boolean] The read_status_enabled
+          # @return [Boolean] Enable the Message Constumption Horizon feature.
           def read_status_enabled
             @properties['read_status_enabled']
           end
 
           ##
-          # @return [Boolean] The reachability_enabled
+          # @return [Boolean] Indicates whether the  the Reachability feature is enabled for this Service instance.
           def reachability_enabled
             @properties['reachability_enabled']
           end
 
           ##
-          # @return [String] The typing_indicator_timeout
+          # @return [String] The amount of time after a "started typing" event when clients should assume that user is no longer typing, even if no "ended typing" message was received.
           def typing_indicator_timeout
             @properties['typing_indicator_timeout']
           end
 
           ##
-          # @return [String] The consumption_report_interval
+          # @return [String] The interval between consumption reports submission batches from client endpoints.
           def consumption_report_interval
             @properties['consumption_report_interval']
           end
@@ -601,43 +616,43 @@ module Twilio
           end
 
           ##
-          # @return [String] The pre_webhook_url
+          # @return [String] The webhook URL for PRE-Event webhooks.
           def pre_webhook_url
             @properties['pre_webhook_url']
           end
 
           ##
-          # @return [String] The post_webhook_url
+          # @return [String] The webhook URL for POST-Event webhooks.
           def post_webhook_url
             @properties['post_webhook_url']
           end
 
           ##
-          # @return [String] The webhook_method
+          # @return [String] The webhook request format to use.
           def webhook_method
             @properties['webhook_method']
           end
 
           ##
-          # @return [String] The webhook_filters
+          # @return [String] The list of WebHook events that are enabled for this Service instance.
           def webhook_filters
             @properties['webhook_filters']
           end
 
           ##
-          # @return [Hash] The notifications
+          # @return [Hash] Notification configuration for the Service instance.
           def notifications
             @properties['notifications']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] An absolute URL for this service.
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] URLs to access the Channels, Roles, and Users for this service.
           def links
             @properties['links']
           end
@@ -658,15 +673,22 @@ module Twilio
 
           ##
           # Update the ServiceInstance
-          # @param [String] friendly_name The friendly_name
+          # @param [String] friendly_name Human-readable name for this service instance
           # @param [String] default_service_role_sid The default_service_role_sid
-          # @param [String] default_channel_role_sid The default_channel_role_sid
-          # @param [String] default_channel_creator_role_sid The
-          #   default_channel_creator_role_sid
-          # @param [Boolean] read_status_enabled The read_status_enabled
-          # @param [Boolean] reachability_enabled The reachability_enabled
-          # @param [String] typing_indicator_timeout The typing_indicator_timeout
-          # @param [String] consumption_report_interval The consumption_report_interval
+          # @param [String] default_channel_role_sid Channel role assigned on channel join
+          #   (see [Roles](https://www.twilio.com/docs/api/chat/rest/v1/roles) data model for
+          #   the details)
+          # @param [String] default_channel_creator_role_sid Channel role assigned to
+          #   creator of channel when joining for first time
+          # @param [Boolean] read_status_enabled `true` if the member read status feature is
+          #   enabled, `false` if not.  Defaults to `true`.
+          # @param [Boolean] reachability_enabled `true` if the reachability feature should
+          #   be enabled.  Defaults to `false`
+          # @param [String] typing_indicator_timeout ISO 8601 duration indicating the
+          #   timeout after "started typing" event when client should assume that user is not
+          #   typing anymore even if no "ended typing" message received
+          # @param [String] consumption_report_interval ISO 8601 duration indicating the
+          #   interval between consumption reports sent from client endpoints.
           # @param [Boolean] notifications_new_message_enabled The
           #   notifications.new_message.enabled
           # @param [String] notifications_new_message_template The
@@ -683,10 +705,18 @@ module Twilio
           #   notifications.invited_to_channel.enabled
           # @param [String] notifications_invited_to_channel_template The
           #   notifications.invited_to_channel.template
-          # @param [String] pre_webhook_url The pre_webhook_url
-          # @param [String] post_webhook_url The post_webhook_url
-          # @param [String] webhook_method The webhook_method
-          # @param [String] webhook_filters The webhook_filters
+          # @param [String] pre_webhook_url The webhook URL for PRE-Event webhooks. See
+          #   [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more
+          #   details.
+          # @param [String] post_webhook_url The webhook URL for POST-Event webhooks. See
+          #   [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more
+          #   details.
+          # @param [String] webhook_method The webhook request format to use.  Must be POST
+          #   or GET. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for
+          #   more details.
+          # @param [String] webhook_filters The list of WebHook events that are enabled for
+          #   this Service instance. See [Webhook
+          #   Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.
           # @param [String] webhooks_on_message_send_url The webhooks.on_message_send.url
           # @param [String] webhooks_on_message_send_method The
           #   webhooks.on_message_send.method