twilio-ruby 5.40.3 → 5.44.0

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

@@ -11,8 +11,6 @@ module Twilio
     class Conversations < Domain
       class V1 < Version
         class ConfigurationContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class WebhookList < ListResource
             ##
             # Initialize the WebhookList
@@ -32,8 +30,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
@@ -63,8 +59,6 @@ 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
@@ -130,8 +124,6 @@ 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

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

@@ -10,8 +10,6 @@ module Twilio
   module REST
     class Conversations < Domain
       class V1 < Version
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ConversationList < ListResource
           ##
           # Initialize the ConversationList
@@ -34,8 +32,8 @@ 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 [Messaging
-          #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
+          # @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
           #   store any data you wish. The string value must contain structurally valid JSON
@@ -156,8 +154,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ConversationPage < Page
           ##
           # Initialize the ConversationPage
@@ -187,8 +183,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ConversationContext < InstanceContext
           ##
           # Initialize the ConversationContext
@@ -219,8 +213,8 @@ 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 [Messaging
-          #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
+          # @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
           #   either `active`, `inactive` or `closed` and defaults to `active`
@@ -228,10 +222,13 @@ module Twilio
           #   switched to `inactive` state. Minimum value for this timer is 1 minute.
           # @param [String] timers_closed ISO8601 duration when conversation will be
           #   switched to `closed` state. Minimum value for this timer is 10 minutes.
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. It can be used to address the resource in place of the
+          #   resource's `sid` in the URL.
           # @param [conversation.WebhookEnabledType] x_twilio_webhook_enabled The
           #   X-Twilio-Webhook-Enabled HTTP request header
           # @return [ConversationInstance] Updated ConversationInstance
-          def update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, x_twilio_webhook_enabled: :unset)
+          def update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, unique_name: :unset, x_twilio_webhook_enabled: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
@@ -241,6 +238,7 @@ module Twilio
                 'State' => state,
                 'Timers.Inactive' => timers_inactive,
                 'Timers.Closed' => timers_closed,
+                'UniqueName' => unique_name,
             })
             headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
@@ -338,8 +336,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ConversationInstance < InstanceResource
           ##
           # Initialize the ConversationInstance
@@ -457,7 +453,7 @@ module Twilio
           end
 
           ##
-          # @return [String] Absolute URLs to access the Participants, Messages and Webhooks of this Conversation.
+          # @return [String] Absolute URLs to access the participants, messages and webhooks of this conversation.
           def links
             @properties['links']
           end
@@ -472,8 +468,8 @@ 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 [Messaging
-          #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
+          # @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
           #   either `active`, `inactive` or `closed` and defaults to `active`
@@ -481,10 +477,13 @@ module Twilio
           #   switched to `inactive` state. Minimum value for this timer is 1 minute.
           # @param [String] timers_closed ISO8601 duration when conversation will be
           #   switched to `closed` state. Minimum value for this timer is 10 minutes.
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. It can be used to address the resource in place of the
+          #   resource's `sid` in the URL.
           # @param [conversation.WebhookEnabledType] x_twilio_webhook_enabled The
           #   X-Twilio-Webhook-Enabled HTTP request header
           # @return [ConversationInstance] Updated ConversationInstance
-          def update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, x_twilio_webhook_enabled: :unset)
+          def update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, unique_name: :unset, x_twilio_webhook_enabled: :unset)
             context.update(
                 friendly_name: friendly_name,
                 date_created: date_created,
@@ -494,6 +493,7 @@ module Twilio
                 state: state,
                 timers_inactive: timers_inactive,
                 timers_closed: timers_closed,
+                unique_name: unique_name,
                 x_twilio_webhook_enabled: x_twilio_webhook_enabled,
             )
           end

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

@@ -11,14 +11,12 @@ 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)
+            #   {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
             #   for this message.
             # @return [MessageList] MessageList
             def initialize(version, conversation_sid: nil)
@@ -148,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
@@ -179,14 +175,12 @@ 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)
+            #   {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.
@@ -299,15 +293,13 @@ 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)
+            #   {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.
@@ -416,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
@@ -428,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,17 +12,15 @@ 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)
+              #   {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)
+              #   {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)
@@ -120,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
@@ -156,17 +152,15 @@ 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)
+              #   {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)
+              #   {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.
@@ -209,18 +203,16 @@ 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)
+              #   {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)
+              #   {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.
@@ -311,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,12 @@ 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)
+            #   {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
             #   for this participant.
             # @return [ParticipantList] ParticipantList
             def initialize(version, conversation_sid: nil)
@@ -32,8 +30,8 @@ module Twilio
             ##
             # Create the ParticipantInstance
             # @param [String] identity A unique string identifier for the conversation
-            #   participant as [Conversation
-            #   User](https://www.twilio.com/docs/conversations/api/user-resource). This
+            #   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
@@ -55,7 +53,7 @@ module Twilio
             #   phone number that is used in Group MMS. Communication mask for the Conversation
             #   participant with Identity.
             # @param [String] role_sid The SID of a conversation-level
-            #   [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to
+            #   {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
@@ -165,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
@@ -196,14 +192,12 @@ 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)
+            #   {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.
@@ -225,15 +219,15 @@ module Twilio
             #   if specified.  **Note** that if the attributes are not set "{}" will be
             #   returned.
             # @param [String] role_sid The SID of a conversation-level
-            #   [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to
+            #   {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 [Conversation
-            #   User](https://www.twilio.com/docs/conversations/api/user-resource). This
+            #   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
@@ -301,15 +295,13 @@ 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)
+            #   {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.
@@ -416,15 +408,15 @@ module Twilio
             #   if specified.  **Note** that if the attributes are not set "{}" will be
             #   returned.
             # @param [String] role_sid The SID of a conversation-level
-            #   [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to
+            #   {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 [Conversation
-            #   User](https://www.twilio.com/docs/conversations/api/user-resource). This
+            #   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

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

@@ -11,14 +11,12 @@ 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)
+            #   {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
             #   for this webhook.
             # @return [WebhookList] WebhookList
             def initialize(version, conversation_sid: nil)
@@ -149,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
@@ -180,14 +176,12 @@ 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)
+            #   {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.
@@ -268,15 +262,13 @@ 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)
+            #   {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.