twilio-ruby 5.9.0 → 5.10.0

data/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb

@@ -16,7 +16,9 @@ module Twilio
               ##
               # Initialize the MessageList
               # @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 message
+              #   belongs to.
               # @param [String] channel_sid The channel_sid
               # @return [MessageList] MessageList
               def initialize(version, service_sid: nil, channel_sid: nil)
@@ -224,8 +226,11 @@ module Twilio
 
               ##
               # Update the MessageInstance
-              # @param [String] body The body
-              # @param [String] attributes The attributes
+              # @param [String] body The new message body string. You can also send structured
+              #   data by serializing it into a string.
+              # @param [String] attributes The new attributes metadata field you can use to
+              #   store any data you wish.  The string value must contain structurally valid JSON
+              #   if specified.
               # @return [MessageInstance] Updated MessageInstance
               def update(body: :unset, attributes: :unset)
                 data = Twilio::Values.of({'Body' => body, 'Attributes' => attributes, })
@@ -258,7 +263,9 @@ module Twilio
               # Initialize the MessageInstance
               # @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 message
+              #   belongs to.
               # @param [String] channel_sid The channel_sid
               # @param [String] sid The sid
               # @return [MessageInstance] MessageInstance
@@ -308,31 +315,31 @@ 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 message.
               def account_sid
                 @properties['account_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 service_sid
+              # @return [String] The unique id of the Service this message belongs to.
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] The to
+              # @return [String] The unique id of the Channel this message was sent to.
               def to
                 @properties['to']
               end
@@ -344,43 +351,43 @@ module Twilio
               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 [Boolean] The was_edited
+              # @return [Boolean] true if the message has been updated since it was created.
               def was_edited
                 @properties['was_edited']
               end
 
               ##
-              # @return [String] The from
+              # @return [String] The identity of the message's author.
               def from
                 @properties['from']
               end
 
               ##
-              # @return [String] The body
+              # @return [String] The contents of the message.
               def body
                 @properties['body']
               end
 
               ##
-              # @return [String] The index
+              # @return [String] The index of the message within the Channel
               def index
                 @properties['index']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] An absolute URL for this message.
               def url
                 @properties['url']
               end
@@ -401,8 +408,11 @@ module Twilio
 
               ##
               # Update the MessageInstance
-              # @param [String] body The body
-              # @param [String] attributes The attributes
+              # @param [String] body The new message body string. You can also send structured
+              #   data by serializing it into a string.
+              # @param [String] attributes The new attributes metadata field you can use to
+              #   store any data you wish.  The string value must contain structurally valid JSON
+              #   if specified.
               # @return [MessageInstance] Updated MessageInstance
               def update(body: :unset, attributes: :unset)
                 context.update(body: body, attributes: attributes, )

data/lib/twilio-ruby/rest/chat/v1/service/channel.rb

@@ -15,7 +15,8 @@ module Twilio
             ##
             # Initialize the ChannelList
             # @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][service] this channel
+            #   belongs to.
             # @return [ChannelList] ChannelList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,10 +29,13 @@ module Twilio
             ##
             # Retrieve a single page of ChannelInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
-            # @param [channel.ChannelType] type The type
+            # @param [String] friendly_name A human-readable name for the Channel. Optional.
+            # @param [String] unique_name A unique, addressable name for the Channel. 
+            #   Optional.
+            # @param [String] attributes An optional metadata field you can use to store any
+            #   data you wish. No processing or validation is done on this field.
+            # @param [channel.ChannelType] type The visibility of the channel - `public` or
+            #   `private`. Defaults to `public`.
             # @return [ChannelInstance] Newly created ChannelInstance
             def create(friendly_name: :unset, unique_name: :unset, attributes: :unset, type: :unset)
               data = Twilio::Values.of({
@@ -216,9 +220,11 @@ module Twilio
 
             ##
             # Update the ChannelInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
+            # @param [String] friendly_name A human-readable name for the Channel. Optional.
+            # @param [String] unique_name A unique, addressable name for the Channel. 
+            #   Optional.
+            # @param [String] attributes An optional metadata field you can use to store any
+            #   data you wish. No processing or validation is done on this field.
             # @return [ChannelInstance] Updated ChannelInstance
             def update(friendly_name: :unset, unique_name: :unset, attributes: :unset)
               data = Twilio::Values.of({
@@ -315,7 +321,8 @@ module Twilio
             # Initialize the ChannelInstance
             # @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][service] this channel
+            #   belongs to.
             # @param [String] sid The sid
             # @return [ChannelInstance] ChannelInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
@@ -356,61 +363,61 @@ 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][/console] responsible for this channel.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The unique id of the [Service][service] this channel belongs to.
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The human-readable name of this channel.
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The unique_name
+            # @return [String] The unique, addressable name of this channel.
             def unique_name
               @properties['unique_name']
             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 [channel.ChannelType] The type
+            # @return [channel.ChannelType] The visibility of this channel - either public or private
             def type
               @properties['type']
             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 created_by
+            # @return [String] Identity of the channel's creator.
             def created_by
               @properties['created_by']
             end
@@ -428,13 +435,13 @@ module Twilio
             end
 
             ##
-            # @return [String] The url
+            # @return [String] An absolute URL for this channel.
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] Absolute URLs to access the [Members][members] and [Messages][messages] for this channel.
             def links
               @properties['links']
             end
@@ -455,9 +462,11 @@ module Twilio
 
             ##
             # Update the ChannelInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
+            # @param [String] friendly_name A human-readable name for the Channel. Optional.
+            # @param [String] unique_name A unique, addressable name for the Channel. 
+            #   Optional.
+            # @param [String] attributes An optional metadata field you can use to store any
+            #   data you wish. No processing or validation is done on this field.
             # @return [ChannelInstance] Updated ChannelInstance
             def update(friendly_name: :unset, unique_name: :unset, attributes: :unset)
               context.update(friendly_name: friendly_name, unique_name: unique_name, attributes: attributes, )

data/lib/twilio-ruby/rest/chat/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/chat/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/chat/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, )