twilio-ruby 5.22.3 → 5.23.0

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

@@ -16,10 +16,12 @@ module Twilio
               ##
               # Initialize the MessageList
               # @param [Version] version Version that contains the resource
-              # @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] service_sid The SID of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+              #   associated with.
+              # @param [String] channel_sid The unique ID of the
+              #   [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the Message
+              #   resource belongs to.
               # @return [MessageList] MessageList
               def initialize(version, service_sid: nil, channel_sid: nil)
                 super(version)
@@ -32,9 +34,14 @@ module Twilio
               ##
               # Retrieve a single page of MessageInstance records from the API.
               # Request is executed immediately.
-              # @param [String] body The body
-              # @param [String] from The from
-              # @param [String] attributes The attributes
+              # @param [String] body The message to send to the channel. Can also be an empty
+              #   string or `null`, which sets the value as an empty string. You can send
+              #   structured data in the body by serializing it as a string.
+              # @param [String] from The
+              #   [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the new
+              #   message's author. The default value is `system`.
+              # @param [String] attributes A valid JSON string that contains
+              #   application-specific data.
               # @return [MessageInstance] Newly created MessageInstance
               def create(body: nil, from: :unset, attributes: :unset)
                 data = Twilio::Values.of({'Body' => body, 'From' => from, 'Attributes' => attributes, })
@@ -57,7 +64,8 @@ module Twilio
               # Lists MessageInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [message.OrderType] order The order
+              # @param [message.OrderType] order The sort order of the returned messages. Can
+              #   be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit.  Default is no limit
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -73,7 +81,8 @@ module Twilio
               # Streams MessageInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [message.OrderType] order The order
+              # @param [message.OrderType] order The sort order of the returned messages. Can
+              #   be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit. Default is no limit.
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -106,7 +115,8 @@ module Twilio
               ##
               # Retrieve a single page of MessageInstance records from the API.
               # Request is executed immediately.
-              # @param [message.OrderType] order The order
+              # @param [message.OrderType] order The sort order of the returned messages. Can
+              #   be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
               # @param [String] page_token PageToken provided by the API
               # @param [Integer] page_number Page Number, this value is simply for client state
               # @param [Integer] page_size Number of records to return, defaults to 50
@@ -184,9 +194,14 @@ module Twilio
               ##
               # Initialize the MessageContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] channel_sid The channel_sid
-              # @param [String] sid The sid
+              # @param [String] service_sid The SID of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the
+              #   resource from.
+              # @param [String] channel_sid The unique ID of the
+              #   [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message to
+              #   fetch belongs to. Can be the Channel's `sid` or `unique_name`.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Message resource to fetch.
               # @return [MessageContext] MessageContext
               def initialize(version, service_sid, channel_sid, sid)
                 super(version)
@@ -226,11 +241,11 @@ module Twilio
 
               ##
               # Update the MessageInstance
-              # @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.
+              # @param [String] body The message to send to the channel. Can also be an empty
+              #   string or `null`, which sets the value as an empty string. You can send
+              #   structured data in the body by serializing it as a string.
+              # @param [String] attributes A valid JSON string that contains
+              #   application-specific data.
               # @return [MessageInstance] Updated MessageInstance
               def update(body: :unset, attributes: :unset)
                 data = Twilio::Values.of({'Body' => body, 'Attributes' => attributes, })
@@ -270,11 +285,14 @@ 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 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
+              # @param [String] service_sid The SID of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+              #   associated with.
+              # @param [String] channel_sid The unique ID of the
+              #   [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the Message
+              #   resource belongs to.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Message resource to fetch.
               # @return [MessageInstance] MessageInstance
               def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
                 super(version)
@@ -322,67 +340,67 @@ module Twilio
               end
 
               ##
-              # @return [String] A 34 character string that uniquely identifies this resource.
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The unique id of the Account responsible for this message.
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] An optional string metadata field you can use to store any data you wish.
+              # @return [String] The JSON string that stores application-specific data
               def attributes
                 @properties['attributes']
               end
 
               ##
-              # @return [String] The unique id of the Service this message belongs to.
+              # @return [String] The SID of the Service that the resource is associated with
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] The unique id of the Channel this message was sent to.
+              # @return [String] The SID of the Channel that the message was sent to
               def to
                 @properties['to']
               end
 
               ##
-              # @return [String] The channel_sid
+              # @return [String] The unique ID of the Channel the Message resource belongs to
               def channel_sid
                 @properties['channel_sid']
               end
 
               ##
-              # @return [Time] The date that this resource was created.
+              # @return [Time] The RFC 2822 date and time in GMT when the resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date that this resource was last updated.
+              # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [Boolean] true if the message has been updated since it was created.
+              # @return [Boolean] Whether the message has been edited since  it was created
               def was_edited
                 @properties['was_edited']
               end
 
               ##
-              # @return [String] The identity of the message's author.
+              # @return [String] The identity of the message's author
               def from
                 @properties['from']
               end
 
               ##
-              # @return [String] The contents of the message.
+              # @return [String] The content of the message
               def body
                 @properties['body']
               end
@@ -394,7 +412,7 @@ module Twilio
               end
 
               ##
-              # @return [String] An absolute URL for this message.
+              # @return [String] The absolute URL of the Message resource
               def url
                 @properties['url']
               end
@@ -415,11 +433,11 @@ module Twilio
 
               ##
               # Update the MessageInstance
-              # @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.
+              # @param [String] body The message to send to the channel. Can also be an empty
+              #   string or `null`, which sets the value as an empty string. You can send
+              #   structured data in the body by serializing it as a string.
+              # @param [String] attributes A valid JSON string that contains
+              #   application-specific data.
               # @return [MessageInstance] Updated MessageInstance
               def update(body: :unset, attributes: :unset)
                 context.update(body: body, attributes: attributes, )

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

@@ -15,9 +15,9 @@ module Twilio
             ##
             # Initialize the RoleList
             # @param [Version] version Version that contains the resource
-            # @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] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+            #   associated with.
             # @return [RoleList] RoleList
             def initialize(version, service_sid: nil)
               super(version)
@@ -30,13 +30,15 @@ module Twilio
             ##
             # Retrieve a single page of RoleInstance records from the API.
             # Request is executed immediately.
-            # @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.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the new resource. It can be up to 64 characters long.
+            # @param [role.RoleType] type The type of role. Can be: `channel` for
+            #   [Channel](https://www.twilio.com/docs/chat/api/channels) roles or `deployment`
+            #   for [Service](https://www.twilio.com/docs/chat/api/services) roles.
+            # @param [String] permission A permission that you grant to the new role. Only one
+            #   permission can be granted per parameter. To assign more than one permission,
+            #   repeat this parameter for each permission value. The values for this parameter
+            #   depend on the role's `type` and are described in the documentation.
             # @return [RoleInstance] Newly created RoleInstance
             def create(friendly_name: nil, type: nil, permission: nil)
               data = Twilio::Values.of({
@@ -176,8 +178,11 @@ module Twilio
             ##
             # Initialize the RoleContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the
+            #   resource from.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the Role
+            #   resource to fetch.
             # @return [RoleContext] RoleContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -211,8 +216,10 @@ module Twilio
 
             ##
             # Update the RoleInstance
-            # @param [String] permission (multiple) A permission this role should have.
-            #   Consult the table above for the list of possible permissions.
+            # @param [String] permission A permission that you grant to the role. Only one
+            #   permission can be granted per parameter. To assign more than one permission,
+            #   repeat this parameter for each permission value. The values for this parameter
+            #   depend on the role's `type` and are described in the documentation.
             # @return [RoleInstance] Updated RoleInstance
             def update(permission: nil)
               data = Twilio::Values.of({'Permission' => Twilio.serialize_list(permission) { |e| e }, })
@@ -246,10 +253,11 @@ 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 unique id of the
-            #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services) this role
-            #   belongs to.
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+            #   associated with.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the Role
+            #   resource to fetch.
             # @return [RoleInstance] RoleInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -284,55 +292,55 @@ module Twilio
             end
 
             ##
-            # @return [String] A 34 character string that uniquely identifies this resource.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The unique id of the Account responsible for this role.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The unique id of the Service this role belongs to.
+            # @return [String] The SID of the Service that the resource is associated with
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The human-readable name of this role.
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [role.RoleType] What kind of role this is.
+            # @return [role.RoleType] The type of role
             def type
               @properties['type']
             end
 
             ##
-            # @return [String] A JSON array of the permissions this role has.
+            # @return [String] An array of the permissions the role has been granted
             def permissions
               @properties['permissions']
             end
 
             ##
-            # @return [Time] The date that this resource was created in ISO 8601 format.
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date that this resource was last updated in ISO 8601 format.
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] An absolute URL for this role.
+            # @return [String] The absolute URL of the Role resource
             def url
               @properties['url']
             end
@@ -353,8 +361,10 @@ module Twilio
 
             ##
             # Update the RoleInstance
-            # @param [String] permission (multiple) A permission this role should have.
-            #   Consult the table above for the list of possible permissions.
+            # @param [String] permission A permission that you grant to the role. Only one
+            #   permission can be granted per parameter. To assign more than one permission,
+            #   repeat this parameter for each permission value. The values for this parameter
+            #   depend on the role's `type` and are described in the documentation.
             # @return [RoleInstance] Updated RoleInstance
             def update(permission: nil)
               context.update(permission: permission, )

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

@@ -15,9 +15,9 @@ module Twilio
             ##
             # Initialize the UserList
             # @param [Version] version Version that contains the resource
-            # @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] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+            #   associated with.
             # @return [UserList] UserList
             def initialize(version, service_sid: nil)
               super(version)
@@ -30,17 +30,18 @@ module Twilio
             ##
             # Retrieve a single page of UserInstance records from the API.
             # Request is executed immediately.
-            # @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.
+            # @param [String] identity The `identity` value that uniquely identifies the new
+            #   resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). This value is
+            #   often a username or email address. See the Identity documentation for more
+            #   details.
+            # @param [String] role_sid The SID of the
+            #   [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new
+            #   User.
+            # @param [String] attributes A valid JSON string that contains
+            #   application-specific data.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the new resource. This value is 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({
@@ -181,8 +182,11 @@ module Twilio
             ##
             # Initialize the UserContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the
+            #   resource from.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the User
+            #   resource to fetch.
             # @return [UserContext] UserContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -219,13 +223,12 @@ module Twilio
 
             ##
             # Update the UserInstance
-            # @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.
+            # @param [String] role_sid The SID of the
+            #   [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user.
+            # @param [String] attributes A valid JSON string that contains
+            #   application-specific data.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It is often used for display purposes.
             # @return [UserInstance] Updated UserInstance
             def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
               data = Twilio::Values.of({
@@ -279,10 +282,11 @@ 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 unique id of the
-            #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services) this user
-            #   belongs to.
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+            #   associated with.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the User
+            #   resource to fetch.
             # @return [UserInstance] UserInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -322,85 +326,85 @@ module Twilio
             end
 
             ##
-            # @return [String] A 34 character string that uniquely identifies this resource.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The unique id of the Account responsible for this user.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The unique id of the Service this user belongs to.
+            # @return [String] The SID of the Service that the resource is associated with
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] An optional string metadata field you can use to store any data you wish.
+            # @return [String] The JSON string that stores application-specific data
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [String] The human-readable name of this user.
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The unique id of the [Role][role] assigned to this user.
+            # @return [String] The SID of the assigned to the user
             def role_sid
               @properties['role_sid']
             end
 
             ##
-            # @return [String] A unique string that identifies the user within this service - often a username or email address.
+            # @return [String] The string that identifies the resource's User
             def identity
               @properties['identity']
             end
 
             ##
-            # @return [Boolean] Indicates whether the User is actively connected to the Service instance and online.
+            # @return [Boolean] Whether the User is actively connected to the Service instance and online
             def is_online
               @properties['is_online']
             end
 
             ##
-            # @return [Boolean] Indicates whether the User has a potentially valid Push Notification registration  for the Service instance.
+            # @return [Boolean] 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 that this resource was created in ISO 8601 format.
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date that this resource was last updated in ISO 8601 format.
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The joined_channels_count
+            # @return [String] The number of Channels this User is a Member of
             def joined_channels_count
               @properties['joined_channels_count']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The absolute URLs of the Channel and Binding resources related to the user
             def links
               @properties['links']
             end
 
             ##
-            # @return [String] An absolute URL for this user.
+            # @return [String] The absolute URL of the User resource
             def url
               @properties['url']
             end
@@ -421,13 +425,12 @@ module Twilio
 
             ##
             # Update the UserInstance
-            # @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.
+            # @param [String] role_sid The SID of the
+            #   [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user.
+            # @param [String] attributes A valid JSON string that contains
+            #   application-specific data.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It is 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, )