twilio-ruby 5.40.2 → 5.43.0

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

@@ -11,14 +11,13 @@ module Twilio
     class Conversations < Domain
       class V1 < Version
         class ConversationContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class MessageList < ListResource
             ##
             # 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 +39,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
@@ -147,8 +146,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class MessagePage < Page
             ##
             # Initialize the MessagePage
@@ -178,14 +175,13 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class MessageContext < InstanceContext
             ##
             # 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
@@ -297,15 +293,14 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class MessageInstance < InstanceResource
             ##
             # 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 +342,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 +390,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
@@ -413,7 +408,7 @@ module Twilio
             end
 
             ##
-            # @return [String] An absolute URL for this message.
+            # @return [String] An absolute API URL for this message.
             def url
               @properties['url']
             end
@@ -425,7 +420,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The links
+            # @return [String] Absolute URL to access the receipts of this message.
             def links
               @properties['links']
             end

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

@@ -12,16 +12,16 @@ module Twilio
       class V1 < Version
         class ConversationContext < InstanceContext
           class MessageContext < InstanceContext
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DeliveryReceiptList < ListResource
               ##
               # 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)
@@ -118,8 +118,6 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DeliveryReceiptPage < Page
               ##
               # Initialize the DeliveryReceiptPage
@@ -154,16 +152,16 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DeliveryReceiptContext < InstanceContext
               ##
               # 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
@@ -205,17 +203,17 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DeliveryReceiptInstance < InstanceResource
               ##
               # 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 +261,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 +279,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 +291,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
@@ -305,7 +303,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status
+              # @return [String] The message {delivery error code}[https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors] for a `failed` status
               def error_code
                 @properties['error_code']
               end

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

@@ -11,14 +11,13 @@ module Twilio
     class Conversations < Domain
       class V1 < Version
         class ConversationContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class ParticipantList < ListResource
             ##
             # 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 +30,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 +50,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
@@ -163,8 +163,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class ParticipantPage < Page
             ##
             # Initialize the ParticipantPage
@@ -194,14 +192,13 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class ParticipantContext < InstanceContext
             ##
             # 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 +218,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
@@ -297,15 +295,14 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class ParticipantInstance < InstanceResource
             ##
             # 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 +340,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 +358,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 +376,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 +407,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

@@ -11,14 +11,13 @@ module Twilio
     class Conversations < Domain
       class V1 < Version
         class ConversationContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class WebhookList < ListResource
             ##
             # 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 +119,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
@@ -148,8 +147,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class WebhookPage < Page
             ##
             # Initialize the WebhookPage
@@ -179,14 +176,13 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class WebhookContext < InstanceContext
             ##
             # 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 +218,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)
@@ -266,15 +262,14 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class WebhookInstance < InstanceResource
             ##
             # 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 +311,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 +369,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)