twilio-ruby 5.20.0 → 5.47.0

data/lib/twilio-ruby/rest/{messaging/v1/session → conversations/v1/conversation}/message.rb

@@ -3,60 +3,60 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
   module REST
-    class Messaging < Domain
+    class Conversations < Domain
       class V1 < Version
-        class SessionContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class ConversationContext < InstanceContext
           class MessageList < ListResource
             ##
             # Initialize the MessageList
             # @param [Version] version Version that contains the resource
-            # @param [String] session_sid The unique id of the
-            #   [Session](https://www.twilio.com/docs/sessions/api/session) 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, session_sid: nil)
+            def initialize(version, conversation_sid: nil)
               super(version)
 
               # Path Solution
-              @solution = {session_sid: session_sid}
-              @uri = "/Sessions/#{@solution[:session_sid]}/Messages"
+              @solution = {conversation_sid: conversation_sid}
+              @uri = "/Conversations/#{@solution[:conversation_sid]}/Messages"
             end
 
             ##
-            # Retrieve a single page of MessageInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] author The
-            #   [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the
-            #   message's author. Defaults to `system`.
-            # @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.
+            # Create the MessageInstance
+            # @param [String] author The channel specific identifier of the message's author.
+            #   Defaults to `system`.
+            # @param [String] body The content of the message, can be up to 1,600 characters
+            #   long.
             # @param [Time] date_created The date that this resource was created.
             # @param [Time] date_updated The date that this resource was last updated. `null`
             #   if the message has not been edited.
-            # @param [String] body The contents of the message.
-            # @return [MessageInstance] Newly created MessageInstance
-            def create(author: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, body: :unset)
+            # @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 [message.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
+            # @return [MessageInstance] Created MessageInstance
+            def create(author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, media_sid: :unset, x_twilio_webhook_enabled: :unset)
               data = Twilio::Values.of({
                   'Author' => author,
-                  'Attributes' => attributes,
+                  'Body' => body,
                   'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
                   'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
-                  'Body' => body,
+                  'Attributes' => attributes,
+                  'MediaSid' => media_sid,
               })
+              headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data, headers: headers)
 
-              MessageInstance.new(@version, payload, session_sid: @solution[:session_sid], )
+              MessageInstance.new(@version, payload, conversation_sid: @solution[:conversation_sid], )
             end
 
             ##
@@ -120,11 +120,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               MessagePage.new(@version, response, @solution)
             end
 
@@ -144,12 +142,10 @@ module Twilio
             ##
             # Provide a user friendly representation
             def to_s
-              '#<Twilio.Messaging.V1.MessageList>'
+              '#<Twilio.Conversations.V1.MessageList>'
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
           class MessagePage < Page
             ##
             # Initialize the MessagePage
@@ -169,129 +165,169 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [MessageInstance] MessageInstance
             def get_instance(payload)
-              MessageInstance.new(@version, payload, session_sid: @solution[:session_sid], )
+              MessageInstance.new(@version, payload, conversation_sid: @solution[:conversation_sid], )
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '<Twilio.Messaging.V1.MessagePage>'
+              '<Twilio.Conversations.V1.MessagePage>'
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
           class MessageContext < InstanceContext
             ##
             # Initialize the MessageContext
             # @param [Version] version Version that contains the resource
-            # @param [String] session_sid The unique id of the
-            #   [Session](https://www.twilio.com/docs/sessions/api/session) 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
-            def initialize(version, session_sid, sid)
+            def initialize(version, conversation_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {session_sid: session_sid, sid: sid, }
-              @uri = "/Sessions/#{@solution[:session_sid]}/Messages/#{@solution[:sid]}"
-            end
-
-            ##
-            # Fetch a MessageInstance
-            # @return [MessageInstance] Fetched MessageInstance
-            def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              @solution = {conversation_sid: conversation_sid, sid: sid, }
+              @uri = "/Conversations/#{@solution[:conversation_sid]}/Messages/#{@solution[:sid]}"
 
-              MessageInstance.new(@version, payload, session_sid: @solution[:session_sid], sid: @solution[:sid], )
+              # Dependents
+              @delivery_receipts = nil
             end
 
             ##
             # Update the MessageInstance
-            # @param [String] author The
-            #   [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the
-            #   message's author. Defaults to `system`.
-            # @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.
+            # @param [String] author The channel specific identifier of the message's author.
+            #   Defaults to `system`.
+            # @param [String] body The content of the message, can be up to 1,600 characters
+            #   long.
             # @param [Time] date_created The date that this resource was created.
             # @param [Time] date_updated The date that this resource was last updated. `null`
             #   if the message has not been edited.
-            # @param [String] body The contents of the message.
+            # @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 [message.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [MessageInstance] Updated MessageInstance
-            def update(author: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, body: :unset)
+            def update(author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, x_twilio_webhook_enabled: :unset)
               data = Twilio::Values.of({
                   'Author' => author,
-                  'Attributes' => attributes,
+                  'Body' => body,
                   'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
                   'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
-                  'Body' => body,
+                  'Attributes' => attributes,
               })
+              headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
+              payload = @version.update('POST', @uri, data: data, headers: headers)
+
+              MessageInstance.new(
+                  @version,
+                  payload,
+                  conversation_sid: @solution[:conversation_sid],
+                  sid: @solution[:sid],
               )
+            end
 
-              MessageInstance.new(@version, payload, session_sid: @solution[:session_sid], sid: @solution[:sid], )
+            ##
+            # Delete the MessageInstance
+            # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete(x_twilio_webhook_enabled: :unset)
+              headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+
+               @version.delete('DELETE', @uri, headers: headers)
             end
 
             ##
-            # Deletes the MessageInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              @version.delete('delete', @uri)
+            # Fetch the MessageInstance
+            # @return [MessageInstance] Fetched MessageInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              MessageInstance.new(
+                  @version,
+                  payload,
+                  conversation_sid: @solution[:conversation_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Access the delivery_receipts
+            # @return [DeliveryReceiptList]
+            # @return [DeliveryReceiptContext] if sid was passed.
+            def delivery_receipts(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return DeliveryReceiptContext.new(@version, @solution[:conversation_sid], @solution[:sid], sid, )
+              end
+
+              unless @delivery_receipts
+                @delivery_receipts = DeliveryReceiptList.new(
+                    @version,
+                    conversation_sid: @solution[:conversation_sid],
+                    message_sid: @solution[:sid],
+                )
+              end
+
+              @delivery_receipts
             end
 
             ##
             # Provide a user friendly representation
             def to_s
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Messaging.V1.MessageContext #{context}>"
+              "#<Twilio.Conversations.V1.MessageContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Conversations.V1.MessageContext #{context}>"
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
           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] session_sid The unique id of the
-            #   [Session](https://www.twilio.com/docs/sessions/api/session) 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
-            def initialize(version, payload, session_sid: nil, sid: nil)
+            def initialize(version, payload, conversation_sid: nil, sid: nil)
               super(version)
 
               # Marshaled Properties
               @properties = {
                   'account_sid' => payload['account_sid'],
-                  'service_sid' => payload['service_sid'],
-                  'messaging_service_sid' => payload['messaging_service_sid'],
-                  'session_sid' => payload['session_sid'],
+                  'conversation_sid' => payload['conversation_sid'],
                   'sid' => payload['sid'],
                   'index' => payload['index'].to_i,
                   'author' => payload['author'],
                   'body' => payload['body'],
+                  'media' => payload['media'],
                   'attributes' => payload['attributes'],
+                  'participant_sid' => payload['participant_sid'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                   'url' => payload['url'],
+                  'delivery' => payload['delivery'],
+                  'links' => payload['links'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'session_sid' => session_sid, 'sid' => sid || @properties['sid'], }
+              @params = {'conversation_sid' => conversation_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -300,33 +336,21 @@ module Twilio
             # @return [MessageContext] MessageContext for this MessageInstance
             def context
               unless @instance_context
-                @instance_context = MessageContext.new(@version, @params['session_sid'], @params['sid'], )
+                @instance_context = MessageContext.new(@version, @params['conversation_sid'], @params['sid'], )
               end
               @instance_context
             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 Chat Service this message belongs to.
-            def service_sid
-              @properties['service_sid']
-            end
-
-            ##
-            # @return [String] The unique id of the SMS Service this message belongs to.
-            def messaging_service_sid
-              @properties['messaging_service_sid']
-            end
-
-            ##
-            # @return [String] The unique id of the Session for this message.
-            def session_sid
-              @properties['session_sid']
+            # @return [String] The unique ID of the Conversation for this message.
+            def conversation_sid
+              @properties['conversation_sid']
             end
 
             ##
@@ -336,29 +360,41 @@ module Twilio
             end
 
             ##
-            # @return [String] The index of the message within the Session
+            # @return [String] The index of the message within the Conversation.
             def index
               @properties['index']
             end
 
             ##
-            # @return [String] The identity or the address of the device of the message's author.
+            # @return [String] The channel specific identifier of the message's author.
             def author
               @properties['author']
             end
 
             ##
-            # @return [String] The contents of the message.
+            # @return [String] The content of the message.
             def body
               @properties['body']
             end
 
+            ##
+            # @return [Array[Hash]] An array of objects that describe the Message's media if attached, otherwise, null.
+            def media
+              @properties['media']
+            end
+
             ##
             # @return [String] A string metadata field you can use to store any data you wish.
             def attributes
               @properties['attributes']
             end
 
+            ##
+            # @return [String] The unique ID of messages's author participant.
+            def participant_sid
+              @properties['participant_sid']
+            end
+
             ##
             # @return [Time] The date that this resource was created.
             def date_created
@@ -372,59 +408,84 @@ 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
 
             ##
-            # Fetch a MessageInstance
-            # @return [MessageInstance] Fetched MessageInstance
-            def fetch
-              context.fetch
+            # @return [Hash] An object that contains the summary of delivery statuses for the message to non-chat participants.
+            def delivery
+              @properties['delivery']
+            end
+
+            ##
+            # @return [String] Absolute URL to access the receipts of this message.
+            def links
+              @properties['links']
             end
 
             ##
             # Update the MessageInstance
-            # @param [String] author The
-            #   [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the
-            #   message's author. Defaults to `system`.
-            # @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.
+            # @param [String] author The channel specific identifier of the message's author.
+            #   Defaults to `system`.
+            # @param [String] body The content of the message, can be up to 1,600 characters
+            #   long.
             # @param [Time] date_created The date that this resource was created.
             # @param [Time] date_updated The date that this resource was last updated. `null`
             #   if the message has not been edited.
-            # @param [String] body The contents of the message.
+            # @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 [message.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [MessageInstance] Updated MessageInstance
-            def update(author: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, body: :unset)
+            def update(author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, x_twilio_webhook_enabled: :unset)
               context.update(
                   author: author,
-                  attributes: attributes,
+                  body: body,
                   date_created: date_created,
                   date_updated: date_updated,
-                  body: body,
+                  attributes: attributes,
+                  x_twilio_webhook_enabled: x_twilio_webhook_enabled,
               )
             end
 
             ##
-            # Deletes the MessageInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              context.delete
+            # Delete the MessageInstance
+            # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete(x_twilio_webhook_enabled: :unset)
+              context.delete(x_twilio_webhook_enabled: x_twilio_webhook_enabled, )
+            end
+
+            ##
+            # Fetch the MessageInstance
+            # @return [MessageInstance] Fetched MessageInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Access the delivery_receipts
+            # @return [delivery_receipts] delivery_receipts
+            def delivery_receipts
+              context.delivery_receipts
             end
 
             ##
             # Provide a user friendly representation
             def to_s
               values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Messaging.V1.MessageInstance #{values}>"
+              "<Twilio.Conversations.V1.MessageInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
               values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Messaging.V1.MessageInstance #{values}>"
+              "<Twilio.Conversations.V1.MessageInstance #{values}>"
             end
           end
         end