twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -17,9 +19,12 @@ module Twilio
                 ##
                 # Initialize the MessageInteractionList
                 # @param [Version] version Version that contains the resource
-                # @param [String] service_sid The unique SID identifier of the Service.
-                # @param [String] session_sid The unique SID identifier of the Session.
-                # @param [String] participant_sid The unique SID identifier of the Participant.
+                # @param [String] service_sid The SID of the parent
+                #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
+                # @param [String] session_sid The SID of the parent
+                #   {Session}[https://www.twilio.com/docs/proxy/api/session] resource.
+                # @param [String] participant_sid The SID of the
+                #   {Participant}[https://www.twilio.com/docs/proxy/api/participant] resource.
                 # @return [MessageInteractionList] MessageInteractionList
                 def initialize(version, service_sid: nil, session_sid: nil, participant_sid: nil)
                   super(version)
@@ -30,19 +35,14 @@ module Twilio
                 end
 
                 ##
-                # Retrieve a single page of MessageInteractionInstance records from the API.
-                # Request is executed immediately.
-                # @param [String] body The body
-                # @param [String] media_url The media_url
-                # @return [MessageInteractionInstance] Newly created MessageInteractionInstance
+                # Create the MessageInteractionInstance
+                # @param [String] body The message to send to the participant
+                # @param [Array[String]] media_url Reserved. Not currently supported.
+                # @return [MessageInteractionInstance] Created MessageInteractionInstance
                 def create(body: :unset, media_url: :unset)
-                  data = Twilio::Values.of({'Body' => body, 'MediaUrl' => Twilio.serialize_list(media_url) { |e| e }})
+                  data = Twilio::Values.of({'Body' => body, 'MediaUrl' => Twilio.serialize_list(media_url) { |e| e }, })
 
-                  payload = @version.create(
-                      'POST',
-                      @uri,
-                      data: data
-                  )
+                  payload = @version.create('POST', @uri, data: data)
 
                   MessageInteractionInstance.new(
                       @version,
@@ -82,7 +82,7 @@ module Twilio
                 def stream(limit: nil, page_size: nil)
                   limits = @version.read_limits(limit, page_size)
 
-                  page = self.page(page_size: limits[:page_size])
+                  page = self.page(page_size: limits[:page_size], )
 
                   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                 end
@@ -94,7 +94,7 @@ module Twilio
                 def each
                   limits = @version.read_limits
 
-                  page = self.page(page_size: limits[:page_size])
+                  page = self.page(page_size: limits[:page_size], )
 
                   @version.stream(page,
                                   limit: limits[:limit],
@@ -114,11 +114,9 @@ module Twilio
                       'Page' => page_number,
                       'PageSize' => page_size,
                   })
-                  response = @version.page(
-                      'GET',
-                      @uri,
-                      params
-                  )
+
+                  response = @version.page('GET', @uri, params: params)
+
                   MessageInteractionPage.new(@version, response, @solution)
                 end
 
@@ -185,11 +183,16 @@ module Twilio
                 ##
                 # Initialize the MessageInteractionContext
                 # @param [Version] version Version that contains the resource
-                # @param [String] service_sid The unique SID identifier of the Service.
-                # @param [String] session_sid The unique SID identifier of the Session.
-                # @param [String] participant_sid The unique SID identifier of the Participant.
-                # @param [String] sid A 34 character string that uniquely identifies this Message
-                #   Interaction.
+                # @param [String] service_sid The SID of the parent
+                #   {Service}[https://www.twilio.com/docs/proxy/api/service] of the resource to
+                #   fetch.
+                # @param [String] session_sid The SID of the parent
+                #   {Session}[https://www.twilio.com/docs/proxy/api/session] of the resource to
+                #   fetch.
+                # @param [String] participant_sid The SID of the
+                #   {Participant}[https://www.twilio.com/docs/proxy/api/participant] resource.
+                # @param [String] sid The Twilio-provided string that uniquely identifies the
+                #   MessageInteraction resource to fetch.
                 # @return [MessageInteractionContext] MessageInteractionContext
                 def initialize(version, service_sid, session_sid, participant_sid, sid)
                   super(version)
@@ -205,16 +208,10 @@ module Twilio
                 end
 
                 ##
-                # Fetch a MessageInteractionInstance
+                # Fetch the MessageInteractionInstance
                 # @return [MessageInteractionInstance] Fetched MessageInteractionInstance
                 def fetch
-                  params = Twilio::Values.of({})
-
-                  payload = @version.fetch(
-                      'GET',
-                      @uri,
-                      params,
-                  )
+                  payload = @version.fetch('GET', @uri)
 
                   MessageInteractionInstance.new(
                       @version,
@@ -232,6 +229,13 @@ module Twilio
                   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                   "#<Twilio.Proxy.V1.MessageInteractionContext #{context}>"
                 end
+
+                ##
+                # Provide a detailed, user friendly representation
+                def inspect
+                  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                  "#<Twilio.Proxy.V1.MessageInteractionContext #{context}>"
+                end
               end
 
               ##
@@ -241,11 +245,14 @@ module Twilio
                 # Initialize the MessageInteractionInstance
                 # @param [Version] version Version that contains the resource
                 # @param [Hash] payload payload that contains response from Twilio
-                # @param [String] service_sid The unique SID identifier of the Service.
-                # @param [String] session_sid The unique SID identifier of the Session.
-                # @param [String] participant_sid The unique SID identifier of the Participant.
-                # @param [String] sid A 34 character string that uniquely identifies this Message
-                #   Interaction.
+                # @param [String] service_sid The SID of the parent
+                #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
+                # @param [String] session_sid The SID of the parent
+                #   {Session}[https://www.twilio.com/docs/proxy/api/session] resource.
+                # @param [String] participant_sid The SID of the
+                #   {Participant}[https://www.twilio.com/docs/proxy/api/participant] resource.
+                # @param [String] sid The Twilio-provided string that uniquely identifies the
+                #   MessageInteraction resource to fetch.
                 # @return [MessageInteractionInstance] MessageInteractionInstance
                 def initialize(version, payload, service_sid: nil, session_sid: nil, participant_sid: nil, sid: nil)
                   super(version)
@@ -302,127 +309,127 @@ module Twilio
                 end
 
                 ##
-                # @return [String] A string that uniquely identifies this Message Interaction.
+                # @return [String] The unique string that identifies the resource
                 def sid
                   @properties['sid']
                 end
 
                 ##
-                # @return [String] Session Sid.
+                # @return [String] The SID of the resource's parent Session
                 def session_sid
                   @properties['session_sid']
                 end
 
                 ##
-                # @return [String] Service Sid.
+                # @return [String] The SID of the resource's parent Service
                 def service_sid
                   @properties['service_sid']
                 end
 
                 ##
-                # @return [String] Account Sid.
+                # @return [String] The SID of the Account that created the resource
                 def account_sid
                   @properties['account_sid']
                 end
 
                 ##
-                # @return [String] Further details about an interaction.
+                # @return [String] A JSON string that includes the message body sent to the participant
                 def data
                   @properties['data']
                 end
 
                 ##
-                # @return [message_interaction.Type] The Type of this Message Interaction
+                # @return [message_interaction.Type] The Type of Message Interaction
                 def type
                   @properties['type']
                 end
 
                 ##
-                # @return [String] Participant Sid.
+                # @return [String] The SID of the Participant resource
                 def participant_sid
                   @properties['participant_sid']
                 end
 
                 ##
-                # @return [String] Inbound Participant Sid.
+                # @return [String] Always empty for Message Interactions
                 def inbound_participant_sid
                   @properties['inbound_participant_sid']
                 end
 
                 ##
-                # @return [String] Inbound Resource Sid.
+                # @return [String] Always empty for Message Interactions
                 def inbound_resource_sid
                   @properties['inbound_resource_sid']
                 end
 
                 ##
-                # @return [message_interaction.ResourceStatus] The Inbound Resource Status of this Message Interaction
+                # @return [message_interaction.ResourceStatus] Always empty for Message Interactions
                 def inbound_resource_status
                   @properties['inbound_resource_status']
                 end
 
                 ##
-                # @return [String] The type of the Inbound Resource, Call or Message.
+                # @return [String] Always empty for Message Interactions
                 def inbound_resource_type
                   @properties['inbound_resource_type']
                 end
 
                 ##
-                # @return [String] The URL of the Twilio resource.
+                # @return [String] Always empty for Message Interactions
                 def inbound_resource_url
                   @properties['inbound_resource_url']
                 end
 
                 ##
-                # @return [String] Outbound Participant Sid.
+                # @return [String] The SID of the outbound Participant resource
                 def outbound_participant_sid
                   @properties['outbound_participant_sid']
                 end
 
                 ##
-                # @return [String] Outbound Resource Sid.
+                # @return [String] The SID of the outbound Message resource
                 def outbound_resource_sid
                   @properties['outbound_resource_sid']
                 end
 
                 ##
-                # @return [message_interaction.ResourceStatus] The Outbound Resource Status of this Message Interaction
+                # @return [message_interaction.ResourceStatus] The outbound resource status
                 def outbound_resource_status
                   @properties['outbound_resource_status']
                 end
 
                 ##
-                # @return [String] The type of the Outbound Resource, Call or Message.
+                # @return [String] The outbound resource type
                 def outbound_resource_type
                   @properties['outbound_resource_type']
                 end
 
                 ##
-                # @return [String] The URL of the Twilio resource.
+                # @return [String] The URL of the Twilio message resource
                 def outbound_resource_url
                   @properties['outbound_resource_url']
                 end
 
                 ##
-                # @return [Time] The date this Message Interaction was created
+                # @return [Time] The ISO 8601 date and time in GMT when the resource was created
                 def date_created
                   @properties['date_created']
                 end
 
                 ##
-                # @return [Time] The date this Message Interaction was updated
+                # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
                 def date_updated
                   @properties['date_updated']
                 end
 
                 ##
-                # @return [String] The URL of this resource.
+                # @return [String] The absolute URL of the MessageInteraction resource
                 def url
                   @properties['url']
                 end
 
                 ##
-                # Fetch a MessageInteractionInstance
+                # Fetch the MessageInteractionInstance
                 # @return [MessageInteractionInstance] Fetched MessageInteractionInstance
                 def fetch
                   context.fetch