twilio-ruby 5.40.2 → 5.40.3

data/lib/twilio-ruby/rest/conversations/v1/conversation.rb

@@ -34,7 +34,7 @@ module Twilio
           #   resource's `sid` in the URL.
           # @param [Time] date_created The date that this resource was created.
           # @param [Time] date_updated The date that this resource was last updated.
-          # @param [String] messaging_service_sid The unique id of the [SMS
+          # @param [String] messaging_service_sid The unique ID of the [Messaging
           #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
           #   to.
           # @param [String] attributes An optional string metadata field you can use to
@@ -219,7 +219,7 @@ module Twilio
           #   store any data you wish. The string value must contain structurally valid JSON
           #   if specified.  **Note** that if the attributes are not set "{}" will be
           #   returned.
-          # @param [String] messaging_service_sid The unique id of the [SMS
+          # @param [String] messaging_service_sid The unique ID of the [Messaging
           #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
           #   to.
           # @param [conversation.State] state Current state of this conversation. Can be
@@ -385,19 +385,19 @@ module Twilio
           end
 
           ##
-          # @return [String] The unique id of the Account responsible for this conversation.
+          # @return [String] The unique ID of the Account responsible for this conversation.
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The unique id of the Chat Service this conversation belongs to.
+          # @return [String] The unique ID of the Conversation Service this conversation belongs to.
           def chat_service_sid
             @properties['chat_service_sid']
           end
 
           ##
-          # @return [String] The unique id of the SMS Service this conversation belongs to.
+          # @return [String] The unique ID of the Messaging Service this conversation belongs to.
           def messaging_service_sid
             @properties['messaging_service_sid']
           end
@@ -472,7 +472,7 @@ module Twilio
           #   store any data you wish. The string value must contain structurally valid JSON
           #   if specified.  **Note** that if the attributes are not set "{}" will be
           #   returned.
-          # @param [String] messaging_service_sid The unique id of the [SMS
+          # @param [String] messaging_service_sid The unique ID of the [Messaging
           #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
           #   to.
           # @param [conversation.State] state Current state of this conversation. Can be

data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb

@@ -17,8 +17,9 @@ module Twilio
             ##
             # Initialize the MessageList
             # @param [Version] version Version that contains the resource
-            # @param [String] conversation_sid The unique id of the
-            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
+            # @param [String] conversation_sid The unique ID of the
+            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+            #   for this message.
             # @return [MessageList] MessageList
             def initialize(version, conversation_sid: nil)
               super(version)
@@ -40,7 +41,7 @@ module Twilio
             # @param [String] attributes A string metadata field you can use to store any data
             #   you wish. The string value must contain structurally valid JSON if specified.
             #   **Note** that if the attributes are not set "{}" will be returned.
-            # @param [String] media_sid The Media Sid to be attached to the new Message.
+            # @param [String] media_sid The Media SID to be attached to the new Message.
             # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The
             #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [MessageInstance] Created MessageInstance
@@ -184,8 +185,9 @@ module Twilio
             ##
             # Initialize the MessageContext
             # @param [Version] version Version that contains the resource
-            # @param [String] conversation_sid The unique id of the
-            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
+            # @param [String] conversation_sid The unique ID of the
+            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+            #   for this message.
             # @param [String] sid A 34 character string that uniquely identifies this
             #   resource.
             # @return [MessageContext] MessageContext
@@ -304,8 +306,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] conversation_sid The unique id of the
-            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
+            # @param [String] conversation_sid The unique ID of the
+            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+            #   for this message.
             # @param [String] sid A 34 character string that uniquely identifies this
             #   resource.
             # @return [MessageInstance] MessageInstance
@@ -347,13 +350,13 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique id of the Account responsible for this message.
+            # @return [String] The unique ID of the Account responsible for this message.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The unique id of the Conversation for this message.
+            # @return [String] The unique ID of the Conversation for this message.
             def conversation_sid
               @properties['conversation_sid']
             end
@@ -395,7 +398,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique id of messages's author participant.
+            # @return [String] The unique ID of messages's author participant.
             def participant_sid
               @properties['participant_sid']
             end

data/lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb

@@ -18,10 +18,12 @@ module Twilio
               ##
               # Initialize the DeliveryReceiptList
               # @param [Version] version Version that contains the resource
-              # @param [String] conversation_sid The unique id of the
-              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
-              # @param [String] message_sid The sid of the message within a
-              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to
+              # @param [String] conversation_sid The unique ID of the
+              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+              #   for this message.
+              # @param [String] message_sid The SID of the message within a
+              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+              #   the delivery receipt belongs to
               # @return [DeliveryReceiptList] DeliveryReceiptList
               def initialize(version, conversation_sid: nil, message_sid: nil)
                 super(version)
@@ -160,10 +162,12 @@ module Twilio
               ##
               # Initialize the DeliveryReceiptContext
               # @param [Version] version Version that contains the resource
-              # @param [String] conversation_sid The unique id of the
-              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
-              # @param [String] message_sid The sid of the message within a
-              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to.
+              # @param [String] conversation_sid The unique ID of the
+              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+              #   for this message.
+              # @param [String] message_sid The SID of the message within a
+              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+              #   the delivery receipt belongs to.
               # @param [String] sid A 34 character string that uniquely identifies this
               #   resource.
               # @return [DeliveryReceiptContext] DeliveryReceiptContext
@@ -212,10 +216,12 @@ module Twilio
               # Initialize the DeliveryReceiptInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] conversation_sid The unique id of the
-              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
-              # @param [String] message_sid The sid of the message within a
-              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to
+              # @param [String] conversation_sid The unique ID of the
+              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+              #   for this message.
+              # @param [String] message_sid The SID of the message within a
+              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+              #   the delivery receipt belongs to
               # @param [String] sid A 34 character string that uniquely identifies this
               #   resource.
               # @return [DeliveryReceiptInstance] DeliveryReceiptInstance
@@ -263,13 +269,13 @@ module Twilio
               end
 
               ##
-              # @return [String] The unique id of the Account responsible for this participant.
+              # @return [String] The unique ID of the Account responsible for this participant.
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The unique id of the Conversation for this message.
+              # @return [String] The unique ID of the Conversation for this message.
               def conversation_sid
                 @properties['conversation_sid']
               end
@@ -281,7 +287,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The sid of the message the delivery receipt belongs to
+              # @return [String] The SID of the message the delivery receipt belongs to
               def message_sid
                 @properties['message_sid']
               end
@@ -293,7 +299,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The unique id of the participant the delivery receipt belongs to.
+              # @return [String] The unique ID of the participant the delivery receipt belongs to.
               def participant_sid
                 @properties['participant_sid']
               end

data/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb

@@ -17,8 +17,9 @@ module Twilio
             ##
             # Initialize the ParticipantList
             # @param [Version] version Version that contains the resource
-            # @param [String] conversation_sid The unique id of the
-            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.
+            # @param [String] conversation_sid The unique ID of the
+            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+            #   for this participant.
             # @return [ParticipantList] ParticipantList
             def initialize(version, conversation_sid: nil)
               super(version)
@@ -31,18 +32,19 @@ module Twilio
             ##
             # Create the ParticipantInstance
             # @param [String] identity A unique string identifier for the conversation
-            #   participant as [Chat User](https://www.twilio.com/docs/chat/rest/user-resource).
-            #   This parameter is non-null if (and only if) the participant is using the
-            #   Programmable Chat SDK to communicate. Limited to 256 characters.
+            #   participant as [Conversation
+            #   User](https://www.twilio.com/docs/conversations/api/user-resource). This
+            #   parameter is non-null if (and only if) the participant is using the
+            #   Conversations SDK to communicate. Limited to 256 characters.
             # @param [String] messaging_binding_address The address of the participant's
-            #   device, e.g. a phone number or Messenger ID. Together with the Proxy address,
-            #   this determines a participant uniquely. This field (with proxy_address) is only
-            #   null when the participant is interacting from a Chat endpoint (see the
-            #   'identity' field).
+            #   device, e.g. a phone or WhatsApp number. Together with the Proxy address, this
+            #   determines a participant uniquely. This field (with proxy_address) is only null
+            #   when the participant is interacting from an SDK endpoint (see the 'identity'
+            #   field).
             # @param [String] messaging_binding_proxy_address The address of the Twilio phone
-            #   number (or WhatsApp number, or Messenger Page ID) that the participant is in
-            #   contact with. This field, together with participant address, is only null when
-            #   the participant is interacting from a Chat endpoint (see the 'identity' field).
+            #   number (or WhatsApp number) that the participant is in contact with. This field,
+            #   together with participant address, is only null when the participant is
+            #   interacting from an SDK endpoint (see the 'identity' field).
             # @param [Time] date_created The date that this resource was created.
             # @param [Time] date_updated The date that this resource was last updated.
             # @param [String] attributes An optional string metadata field you can use to
@@ -50,11 +52,11 @@ module Twilio
             #   if specified.  **Note** that if the attributes are not set "{}" will be
             #   returned.
             # @param [String] messaging_binding_projected_address The address of the Twilio
-            #   phone number that is used in Group MMS. Communication mask for the Chat
+            #   phone number that is used in Group MMS. Communication mask for the Conversation
             #   participant with Identity.
-            # @param [String] role_sid The SID of the
-            #   [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the
-            #   participant.
+            # @param [String] role_sid The SID of a conversation-level
+            #   [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to
+            #   the participant.
             # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The
             #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [ParticipantInstance] Created ParticipantInstance
@@ -200,8 +202,9 @@ module Twilio
             ##
             # Initialize the ParticipantContext
             # @param [Version] version Version that contains the resource
-            # @param [String] conversation_sid The unique id of the
-            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.
+            # @param [String] conversation_sid The unique ID of the
+            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+            #   for this participant.
             # @param [String] sid A 34 character string that uniquely identifies this
             #   resource.
             # @return [ParticipantContext] ParticipantContext
@@ -221,17 +224,18 @@ module Twilio
             #   store any data you wish. The string value must contain structurally valid JSON
             #   if specified.  **Note** that if the attributes are not set "{}" will be
             #   returned.
-            # @param [String] role_sid The SID of the
-            #   [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the
-            #   participant.
+            # @param [String] role_sid The SID of a conversation-level
+            #   [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to
+            #   the participant.
             # @param [String] messaging_binding_proxy_address The address of the Twilio phone
             #   number that the participant is in contact with. 'null' value will remove it.
             # @param [String] messaging_binding_projected_address The address of the Twilio
             #   phone number that is used in Group MMS. 'null' value will remove it.
             # @param [String] identity A unique string identifier for the conversation
-            #   participant as [Chat User](https://www.twilio.com/docs/chat/rest/user-resource).
-            #   This parameter is non-null if (and only if) the participant is using the
-            #   Programmable Chat SDK to communicate. Limited to 256 characters.
+            #   participant as [Conversation
+            #   User](https://www.twilio.com/docs/conversations/api/user-resource). This
+            #   parameter is non-null if (and only if) the participant is using the
+            #   Conversations SDK to communicate. Limited to 256 characters.
             # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The
             #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [ParticipantInstance] Updated ParticipantInstance
@@ -304,8 +308,9 @@ module Twilio
             # Initialize the ParticipantInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] conversation_sid The unique id of the
-            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.
+            # @param [String] conversation_sid The unique ID of the
+            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+            #   for this participant.
             # @param [String] sid A 34 character string that uniquely identifies this
             #   resource.
             # @return [ParticipantInstance] ParticipantInstance
@@ -343,13 +348,13 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique id of the Account responsible for this participant.
+            # @return [String] The unique ID of the Account responsible for this participant.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The unique id of the Conversation for this participant.
+            # @return [String] The unique ID of the Conversation for this participant.
             def conversation_sid
               @properties['conversation_sid']
             end
@@ -361,7 +366,7 @@ module Twilio
             end
 
             ##
-            # @return [String] A unique string identifier for the conversation participant as Chat User.
+            # @return [String] A unique string identifier for the conversation participant as Conversation User.
             def identity
               @properties['identity']
             end
@@ -379,7 +384,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The SID of the Role to assign to the participant
+            # @return [String] The SID of a conversation-level Role to assign to the participant
             def role_sid
               @properties['role_sid']
             end
@@ -410,17 +415,18 @@ module Twilio
             #   store any data you wish. The string value must contain structurally valid JSON
             #   if specified.  **Note** that if the attributes are not set "{}" will be
             #   returned.
-            # @param [String] role_sid The SID of the
-            #   [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the
-            #   participant.
+            # @param [String] role_sid The SID of a conversation-level
+            #   [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to
+            #   the participant.
             # @param [String] messaging_binding_proxy_address The address of the Twilio phone
             #   number that the participant is in contact with. 'null' value will remove it.
             # @param [String] messaging_binding_projected_address The address of the Twilio
             #   phone number that is used in Group MMS. 'null' value will remove it.
             # @param [String] identity A unique string identifier for the conversation
-            #   participant as [Chat User](https://www.twilio.com/docs/chat/rest/user-resource).
-            #   This parameter is non-null if (and only if) the participant is using the
-            #   Programmable Chat SDK to communicate. Limited to 256 characters.
+            #   participant as [Conversation
+            #   User](https://www.twilio.com/docs/conversations/api/user-resource). This
+            #   parameter is non-null if (and only if) the participant is using the
+            #   Conversations SDK to communicate. Limited to 256 characters.
             # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The
             #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [ParticipantInstance] Updated ParticipantInstance

data/lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb

@@ -17,8 +17,9 @@ module Twilio
             ##
             # Initialize the WebhookList
             # @param [Version] version Version that contains the resource
-            # @param [String] conversation_sid The unique id of the
-            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
+            # @param [String] conversation_sid The unique ID of the
+            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+            #   for this webhook.
             # @return [WebhookList] WebhookList
             def initialize(version, conversation_sid: nil)
               super(version)
@@ -120,7 +121,7 @@ module Twilio
             #   for this Conversation.
             # @param [String] configuration_triggers The list of keywords, firing webhook
             #   event for this Conversation.
-            # @param [String] configuration_flow_sid The studio flow sid, where the webhook
+            # @param [String] configuration_flow_sid The studio flow SID, where the webhook
             #   should be sent to.
             # @param [String] configuration_replay_after The message index for which and it's
             #   successors the webhook will be replayed. Not set by default
@@ -185,8 +186,9 @@ module Twilio
             ##
             # Initialize the WebhookContext
             # @param [Version] version Version that contains the resource
-            # @param [String] conversation_sid The unique id of the
-            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
+            # @param [String] conversation_sid The unique ID of the
+            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+            #   for this webhook.
             # @param [String] sid A 34 character string that uniquely identifies this
             #   resource.
             # @return [WebhookContext] WebhookContext
@@ -222,7 +224,7 @@ module Twilio
             #   for this Conversation.
             # @param [String] configuration_triggers The list of keywords, firing webhook
             #   event for this Conversation.
-            # @param [String] configuration_flow_sid The studio flow sid, where the webhook
+            # @param [String] configuration_flow_sid The studio flow SID, where the webhook
             #   should be sent to.
             # @return [WebhookInstance] Updated WebhookInstance
             def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset)
@@ -273,8 +275,9 @@ module Twilio
             # Initialize the WebhookInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] conversation_sid The unique id of the
-            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
+            # @param [String] conversation_sid The unique ID of the
+            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+            #   for this webhook.
             # @param [String] sid A 34 character string that uniquely identifies this
             #   resource.
             # @return [WebhookInstance] WebhookInstance
@@ -316,13 +319,13 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique id of the Account responsible for this conversation.
+            # @return [String] The unique ID of the Account responsible for this conversation.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The unique id of the Conversation for this webhook.
+            # @return [String] The unique ID of the Conversation for this webhook.
             def conversation_sid
               @properties['conversation_sid']
             end
@@ -374,7 +377,7 @@ module Twilio
             #   for this Conversation.
             # @param [String] configuration_triggers The list of keywords, firing webhook
             #   event for this Conversation.
-            # @param [String] configuration_flow_sid The studio flow sid, where the webhook
+            # @param [String] configuration_flow_sid The studio flow SID, where the webhook
             #   should be sent to.
             # @return [WebhookInstance] Updated WebhookInstance
             def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset)

data/lib/twilio-ruby/rest/conversations/v1/credential.rb

@@ -317,7 +317,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The unique id of the Account responsible for this credential.
+          # @return [String] The unique ID of the Account responsible for this credential.
           def account_sid
             @properties['account_sid']
           end

data/lib/twilio-ruby/rest/conversations/v1/role.rb

@@ -30,7 +30,9 @@ module Twilio
           # @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: `conversation` for
-          #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) roles or `service` for [Service](https://www.twilio.com/docs/chat/rest/service-resource) roles.
+          #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+          #   roles or `service` for [Conversation
+          #   Service](https://www.twilio.com/docs/conversations/api/service-resource) 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
@@ -284,7 +286,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The SID of the Service that the resource is associated with
+          # @return [String] The SID of the Conversation Service that the resource is associated with
           def chat_service_sid
             @properties['chat_service_sid']
           end