twilio-ruby 5.25.4 → 5.26.0

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

@@ -17,9 +17,9 @@ module Twilio
               # Initialize the MessageList
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
-              #   associated with.
-              # @param [String] channel_sid The unique ID of the
+              #   [Service](https://www.twilio.com/docs/chat/rest/services) the Message resource
+              #   is associated with.
+              # @param [String] channel_sid The SID of the
               #   [Channel](https://www.twilio.com/docs/chat/channels) the Message resource
               #   belongs to.
               # @return [MessageList] MessageList
@@ -34,26 +34,24 @@ module Twilio
               ##
               # Retrieve a single page of MessageInstance records from the API.
               # Request is executed immediately.
-              # @param [String] from The [identity](https://www.twilio.com/docs/chat/identity)
+              # @param [String] from The [Identity](https://www.twilio.com/docs/chat/identity)
               #   of the new message's author. The default value is `system`.
               # @param [String] attributes A valid JSON string that contains
               #   application-specific data.
               # @param [Time] date_created The date, specified in [ISO
               #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
-              #   as the date it was created. The default is the current time set by the Chat
-              #   service. This parameter should only be used when a Chat's history is being
+              #   as the date it was created. The default value is the current time set by the
+              #   Chat service. This parameter should only be used when a Chat's history is being
               #   recreated from a backup/separate source.
               # @param [Time] date_updated The date, specified in [ISO
               #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
-              #   as the date it was last updated. The default value is `null`. Note that this
-              #   parameter should only be used when a Chat's history is being recreated from a
-              #   backup/separate source  and where a Message was previously updated.
+              #   as the date it was last updated.
               # @param [String] last_updated_by The
-              #   [identity](https://www.twilio.com/docs/chat/identity) of the User who last
+              #   [Identity](https://www.twilio.com/docs/chat/identity) of the User who last
               #   updated the Message, if applicable.
-              # @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] body The message to send to the channel. Can 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] media_sid The SID of the
               #   [Media](https://www.twilio.com/docs/chat/rest/media) to attach to the new
               #   Message.
@@ -218,13 +216,13 @@ module Twilio
               # Initialize the MessageContext
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/services) to fetch the resource
-              #   from.
-              # @param [String] channel_sid The unique ID of the
-              #   [Channel](https://www.twilio.com/docs/chat/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.
+              #   [Service](https://www.twilio.com/docs/chat/rest/services) to fetch the Message
+              #   resource from.
+              # @param [String] channel_sid The SID of the
+              #   [Channel](https://www.twilio.com/docs/chat/channels) the Message resource to
+              #   fetch belongs to. This value can be the Channel resource's `sid` or
+              #   `unique_name`.
+              # @param [String] sid The SID of the Message resource to fetch.
               # @return [MessageContext] MessageContext
               def initialize(version, service_sid, channel_sid, sid)
                 super(version)
@@ -257,21 +255,23 @@ module Twilio
 
               ##
               # Deletes the MessageInstance
-              # @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 MessageInstance
-              # @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] body The message to send to the channel. Can 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.
               # @param [Time] date_created The date, specified in [ISO
               #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
-              #   as the date it was created.
+              #   as the date it was created. The default value is the current time set by the
+              #   Chat service. This parameter should only be used when a Chat's history is being
+              #   recreated from a backup/separate source.
               # @param [Time] date_updated The date, specified in [ISO
               #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
               #   as the date it was last updated.
@@ -327,13 +327,12 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
-              #   associated with.
-              # @param [String] channel_sid The unique ID of the
+              #   [Service](https://www.twilio.com/docs/chat/rest/services) the Message resource
+              #   is associated with.
+              # @param [String] channel_sid The SID of the
               #   [Channel](https://www.twilio.com/docs/chat/channels) the Message resource
               #   belongs to.
-              # @param [String] sid The Twilio-provided string that uniquely identifies the
-              #   Message resource to fetch.
+              # @param [String] sid The SID of the Message resource to fetch.
               # @return [MessageInstance] MessageInstance
               def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
                 super(version)
@@ -414,7 +413,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The unique ID of the Channel the Message resource belongs to
+              # @return [String] The SID of the Channel the Message resource belongs to
               def channel_sid
                 @properties['channel_sid']
               end
@@ -444,7 +443,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The identity of the message's author
+              # @return [String] The Identity of the message's author
               def from
                 @properties['from']
               end
@@ -488,21 +487,23 @@ module Twilio
 
               ##
               # Deletes the MessageInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
 
               ##
               # Update the MessageInstance
-              # @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] body The message to send to the channel. Can 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.
               # @param [Time] date_created The date, specified in [ISO
               #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
-              #   as the date it was created.
+              #   as the date it was created. The default value is the current time set by the
+              #   Chat service. This parameter should only be used when a Chat's history is being
+              #   recreated from a backup/separate source.
               # @param [Time] date_updated The date, specified in [ISO
               #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
               #   as the date it was last updated.

data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb

@@ -17,11 +17,11 @@ module Twilio
               # Initialize the WebhookList
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
-              #   associated with.
+              #   [Service](https://www.twilio.com/docs/chat/rest/services) the Channel Webhook
+              #   resource is associated with.
               # @param [String] channel_sid The SID of the
-              #   [Channel](https://www.twilio.com/docs/chat/channels) the ChannelWebhook resource
-              #   belongs to.
+              #   [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook
+              #   resource belongs to.
               # @return [WebhookList] WebhookList
               def initialize(version, service_sid: nil, channel_sid: nil)
                 super(version)
@@ -128,7 +128,7 @@ module Twilio
               #   the list of possible events, see [Webhook Event
               #   Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger).
               # @param [String] configuration_triggers A string that will cause us to call the
-              #   webhook when it is found in a message body. This parameter takes only one
+              #   webhook when it is present in a message body. This parameter takes only one
               #   trigger string. To specify more than one, repeat this parameter for each trigger
               #   string up to a total of 5 trigger strings. Used only when `type` = `trigger`.
               # @param [String] configuration_flow_sid The SID of the Studio
@@ -209,13 +209,13 @@ module Twilio
               # Initialize the WebhookContext
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/services) to fetch the resource
-              #   from.
+              #   [Service](https://www.twilio.com/docs/chat/rest/services) with the Channel to
+              #   fetch the Webhook resource from.
               # @param [String] channel_sid The SID of the
-              #   [Channel](https://www.twilio.com/docs/chat/channels) the resource to fetch
-              #   belongs to.
-              # @param [String] sid The Twilio-provided string that uniquely identifies the
-              #   ChannelWebhook resource to fetch.
+              #   [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook
+              #   resource to fetch belongs to. This value can be the Channel resource's `sid` or
+              #   `unique_name`.
+              # @param [String] sid The SID of the Channel Webhook resource to fetch.
               # @return [WebhookContext] WebhookContext
               def initialize(version, service_sid, channel_sid, sid)
                 super(version)
@@ -258,7 +258,7 @@ module Twilio
               #   the list of possible events, see [Webhook Event
               #   Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger).
               # @param [String] configuration_triggers A string that will cause us to call the
-              #   webhook when it is found in a message body. This parameter takes only one
+              #   webhook when it is present in a message body. This parameter takes only one
               #   trigger string. To specify more than one, repeat this parameter for each trigger
               #   string up to a total of 5 trigger strings. Used only when `type` = `trigger`.
               # @param [String] configuration_flow_sid The SID of the Studio
@@ -295,7 +295,7 @@ module Twilio
 
               ##
               # Deletes the WebhookInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
@@ -321,13 +321,12 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
-              #   associated with.
+              #   [Service](https://www.twilio.com/docs/chat/rest/services) the Channel Webhook
+              #   resource is associated with.
               # @param [String] channel_sid The SID of the
-              #   [Channel](https://www.twilio.com/docs/chat/channels) the ChannelWebhook resource
-              #   belongs to.
-              # @param [String] sid The Twilio-provided string that uniquely identifies the
-              #   ChannelWebhook resource to fetch.
+              #   [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook
+              #   resource belongs to.
+              # @param [String] sid The SID of the Channel Webhook resource to fetch.
               # @return [WebhookInstance] WebhookInstance
               def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
                 super(version)
@@ -383,13 +382,13 @@ module Twilio
               end
 
               ##
-              # @return [String] The SID of the Service that the resource is associated with
+              # @return [String] The SID of the Service that the Channel Webhook resource is associated with
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] The SID of the Channel the ChannelWebhook resource belongs to
+              # @return [String] The SID of the Channel the Channel Webhook resource belongs to
               def channel_sid
                 @properties['channel_sid']
               end
@@ -401,7 +400,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The absolute URL of the resource
+              # @return [String] The absolute URL of the Channel Webhook resource
               def url
                 @properties['url']
               end
@@ -413,13 +412,13 @@ module Twilio
               end
 
               ##
-              # @return [Time] The RFC 2822 date and time in GMT when the resource was created
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
@@ -443,7 +442,7 @@ module Twilio
               #   the list of possible events, see [Webhook Event
               #   Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger).
               # @param [String] configuration_triggers A string that will cause us to call the
-              #   webhook when it is found in a message body. This parameter takes only one
+              #   webhook when it is present in a message body. This parameter takes only one
               #   trigger string. To specify more than one, repeat this parameter for each trigger
               #   string up to a total of 5 trigger strings. Used only when `type` = `trigger`.
               # @param [String] configuration_flow_sid The SID of the Studio
@@ -466,7 +465,7 @@ module Twilio
 
               ##
               # Deletes the WebhookInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end

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

@@ -16,7 +16,7 @@ module Twilio
             # Initialize the RoleList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
+            #   [Service](https://www.twilio.com/docs/chat/rest/services) the Role resource is
             #   associated with.
             # @return [RoleList] RoleList
             def initialize(version, service_sid: nil)
@@ -38,7 +38,7 @@ module Twilio
             # @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.
+            #   depend on the role's `type`.
             # @return [RoleInstance] Newly created RoleInstance
             def create(friendly_name: nil, type: nil, permission: nil)
               data = Twilio::Values.of({
@@ -179,10 +179,9 @@ module Twilio
             # Initialize the RoleContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/services) to fetch the resource
-            #   from.
-            # @param [String] sid The Twilio-provided string that uniquely identifies the Role
-            #   resource to fetch.
+            #   [Service](https://www.twilio.com/docs/chat/rest/services) to fetch the Role
+            #   resource from.
+            # @param [String] sid The SID of the Role resource to fetch.
             # @return [RoleContext] RoleContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -209,7 +208,7 @@ module Twilio
 
             ##
             # Deletes the RoleInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -218,8 +217,10 @@ module Twilio
             # Update the RoleInstance
             # @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.
+            #   repeat this parameter for each permission value. Note that the update action
+            #   replaces all previously assigned permissions with those defined in the update
+            #   action. To remove a permission, do not include it in the subsequent update
+            #   action. The values for this parameter depend on the role's `type`.
             # @return [RoleInstance] Updated RoleInstance
             def update(permission: nil)
               data = Twilio::Values.of({'Permission' => Twilio.serialize_list(permission) { |e| e }, })
@@ -254,10 +255,9 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
+            #   [Service](https://www.twilio.com/docs/chat/rest/services) the Role resource is
             #   associated with.
-            # @param [String] sid The Twilio-provided string that uniquely identifies the Role
-            #   resource to fetch.
+            # @param [String] sid The SID of the Role resource to fetch.
             # @return [RoleInstance] RoleInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -328,13 +328,13 @@ module Twilio
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
@@ -354,7 +354,7 @@ module Twilio
 
             ##
             # Deletes the RoleInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
@@ -363,8 +363,10 @@ module Twilio
             # Update the RoleInstance
             # @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.
+            #   repeat this parameter for each permission value. Note that the update action
+            #   replaces all previously assigned permissions with those defined in the update
+            #   action. To remove a permission, do not include it in the subsequent update
+            #   action. The values for this parameter depend on the role's `type`.
             # @return [RoleInstance] Updated RoleInstance
             def update(permission: nil)
               context.update(permission: permission, )

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

@@ -16,7 +16,7 @@ module Twilio
             # Initialize the UserList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
+            #   [Service](https://www.twilio.com/docs/chat/rest/services) the User resource is
             #   associated with.
             # @return [UserList] UserList
             def initialize(version, service_sid: nil)
@@ -33,9 +33,9 @@ module Twilio
             # @param [String] identity The `identity` value that uniquely identifies the new
             #   resource's [User](https://www.twilio.com/docs/chat/rest/users) within the
             #   [Service](https://www.twilio.com/docs/chat/rest/services). This value is often a
-            #   username or email address. See the Identity documentation for more details.
+            #   username or email address. See the Identity documentation for more info.
             # @param [String] role_sid The SID of the
-            #   [Role](https://www.twilio.com/docs/chat/rest/roles) assigned to the new User.
+            #   [Role](https://www.twilio.com/docs/chat/rest/roles) to assign 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
@@ -181,10 +181,10 @@ module Twilio
             # Initialize the UserContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/services) to fetch the resource
-            #   from.
-            # @param [String] sid The Twilio-provided string that uniquely identifies the User
-            #   resource to fetch.
+            #   [Service](https://www.twilio.com/docs/chat/rest/services) to fetch the User
+            #   resource from.
+            # @param [String] sid The SID of the User resource to fetch. This value can be
+            #   either the `sid` or the `identity` of the User resource to fetch.
             # @return [UserContext] UserContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -215,7 +215,7 @@ module Twilio
 
             ##
             # Deletes the UserInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -223,7 +223,7 @@ module Twilio
             ##
             # Update the UserInstance
             # @param [String] role_sid The SID of the
-            #   [Role](https://www.twilio.com/docs/chat/rest/roles) assigned to this user.
+            #   [Role](https://www.twilio.com/docs/chat/rest/roles) to assign to the 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
@@ -310,10 +310,10 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/services) the resource is
+            #   [Service](https://www.twilio.com/docs/chat/rest/services) the User resource is
             #   associated with.
-            # @param [String] sid The Twilio-provided string that uniquely identifies the User
-            #   resource to fetch.
+            # @param [String] sid The SID of the User resource to fetch. This value can be
+            #   either the `sid` or the `identity` of the User resource to fetch.
             # @return [UserInstance] UserInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -407,19 +407,19 @@ module Twilio
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The number of Channels this User is a Member of
+            # @return [String] The number of Channels the User is a Member of
             def joined_channels_count
               @properties['joined_channels_count']
             end
@@ -445,7 +445,7 @@ module Twilio
 
             ##
             # Deletes the UserInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
@@ -453,7 +453,7 @@ module Twilio
             ##
             # Update the UserInstance
             # @param [String] role_sid The SID of the
-            #   [Role](https://www.twilio.com/docs/chat/rest/roles) assigned to this user.
+            #   [Role](https://www.twilio.com/docs/chat/rest/roles) to assign to the 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