twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,12 @@ module Twilio
               ##
               # Initialize the MessageList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] channel_sid The channel_sid
+              # @param [String] service_sid The SID of the
+              #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is
+              #   associated with.
+              # @param [String] channel_sid The unique ID of the
+              #   {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the Message
+              #   resource belongs to.
               # @return [MessageList] MessageList
               def initialize(version, service_sid: nil, channel_sid: nil)
                 super(version)
@@ -26,20 +32,20 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of MessageInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] body The body
-              # @param [String] from The from
-              # @param [String] attributes The attributes
-              # @return [MessageInstance] Newly created MessageInstance
+              # Create the MessageInstance
+              # @param [String] body The message to send to the channel. Can also be an empty
+              #   string or `null`, which sets the value as an empty string. You can send
+              #   structured data in the body by serializing it as a string.
+              # @param [String] from The
+              #   {identity}[https://www.twilio.com/docs/api/chat/guides/identity] of the new
+              #   message's author. The default value is `system`.
+              # @param [String] attributes A valid JSON string that contains
+              #   application-specific data.
+              # @return [MessageInstance] Created MessageInstance
               def create(body: nil, from: :unset, attributes: :unset)
-                data = Twilio::Values.of({'Body' => body, 'From' => from, 'Attributes' => attributes})
+                data = Twilio::Values.of({'Body' => body, 'From' => from, 'Attributes' => attributes, })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 MessageInstance.new(
                     @version,
@@ -53,7 +59,8 @@ module Twilio
               # Lists MessageInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [message.OrderType] order The order
+              # @param [message.OrderType] order The sort order of the returned messages. Can
+              #   be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit.  Default is no limit
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -69,7 +76,8 @@ module Twilio
               # Streams MessageInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [message.OrderType] order The order
+              # @param [message.OrderType] order The sort order of the returned messages. Can
+              #   be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit. Default is no limit.
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -80,7 +88,7 @@ module Twilio
               def stream(order: :unset, limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(order: order, page_size: limits[:page_size])
+                page = self.page(order: order, page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -92,7 +100,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],
@@ -102,7 +110,8 @@ module Twilio
               ##
               # Retrieve a single page of MessageInstance records from the API.
               # Request is executed immediately.
-              # @param [message.OrderType] order The order
+              # @param [message.OrderType] order The sort order of the returned messages. Can
+              #   be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
               # @param [String] page_token PageToken provided by the API
               # @param [Integer] page_number Page Number, this value is simply for client state
               # @param [Integer] page_size Number of records to return, defaults to 50
@@ -114,11 +123,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
 
@@ -180,29 +187,28 @@ module Twilio
               ##
               # Initialize the MessageContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] channel_sid The channel_sid
-              # @param [String] sid The sid
+              # @param [String] service_sid The SID of the
+              #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the
+              #   resource from.
+              # @param [String] channel_sid The unique ID of the
+              #   {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the message to
+              #   fetch belongs to. Can be the Channel's `sid` or `unique_name`.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Message resource to fetch.
               # @return [MessageContext] MessageContext
               def initialize(version, service_sid, channel_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, channel_sid: channel_sid, sid: sid}
+                @solution = {service_sid: service_sid, channel_sid: channel_sid, sid: sid, }
                 @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Messages/#{@solution[:sid]}"
               end
 
               ##
-              # Fetch a MessageInstance
+              # Fetch the MessageInstance
               # @return [MessageInstance] Fetched MessageInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 MessageInstance.new(
                     @version,
@@ -214,25 +220,24 @@ module Twilio
               end
 
               ##
-              # Deletes the MessageInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the MessageInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
               # Update the MessageInstance
-              # @param [String] body The body
-              # @param [String] attributes The attributes
+              # @param [String] body The message to send to the channel. Can also be an empty
+              #   string or `null`, which sets the value as an empty string. You can send
+              #   structured data in the body by serializing it as a string.
+              # @param [String] attributes A valid JSON string that contains
+              #   application-specific data.
               # @return [MessageInstance] Updated MessageInstance
               def update(body: :unset, attributes: :unset)
-                data = Twilio::Values.of({'Body' => body, 'Attributes' => attributes})
+                data = Twilio::Values.of({'Body' => body, 'Attributes' => attributes, })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 MessageInstance.new(
                     @version,
@@ -249,6 +254,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Chat.V1.MessageContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Chat.V1.MessageContext #{context}>"
+              end
             end
 
             class MessageInstance < InstanceResource
@@ -256,9 +268,14 @@ module Twilio
               # Initialize the MessageInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] service_sid The service_sid
-              # @param [String] channel_sid The channel_sid
-              # @param [String] sid The sid
+              # @param [String] service_sid The SID of the
+              #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is
+              #   associated with.
+              # @param [String] channel_sid The unique ID of the
+              #   {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the Message
+              #   resource belongs to.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Message resource to fetch.
               # @return [MessageInstance] MessageInstance
               def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
                 super(version)
@@ -306,104 +323,107 @@ module Twilio
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The attributes
+              # @return [String] The JSON string that stores application-specific data
               def attributes
                 @properties['attributes']
               end
 
               ##
-              # @return [String] The service_sid
+              # @return [String] The SID of the Service that the resource is associated with
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] The to
+              # @return [String] The SID of the Channel that the message was sent to
               def to
                 @properties['to']
               end
 
               ##
-              # @return [String] The channel_sid
+              # @return [String] The unique ID of the Channel the Message resource belongs to
               def channel_sid
                 @properties['channel_sid']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The RFC 2822 date and time in GMT when the resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [Boolean] The was_edited
+              # @return [Boolean] Whether the message has been edited since  it was created
               def was_edited
                 @properties['was_edited']
               end
 
               ##
-              # @return [String] The from
+              # @return [String] The identity of the message's author
               def from
                 @properties['from']
               end
 
               ##
-              # @return [String] The body
+              # @return [String] The content of the message
               def body
                 @properties['body']
               end
 
               ##
-              # @return [String] The index
+              # @return [String] The index of the message within the Channel
               def index
                 @properties['index']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the Message resource
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a MessageInstance
+              # Fetch the MessageInstance
               # @return [MessageInstance] Fetched MessageInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the MessageInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the MessageInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
 
               ##
               # Update the MessageInstance
-              # @param [String] body The body
-              # @param [String] attributes The attributes
+              # @param [String] body The message to send to the channel. Can also be an empty
+              #   string or `null`, which sets the value as an empty string. You can send
+              #   structured data in the body by serializing it as a string.
+              # @param [String] attributes A valid JSON string that contains
+              #   application-specific data.
               # @return [MessageInstance] Updated MessageInstance
               def update(body: :unset, attributes: :unset)
-                context.update(body: body, attributes: attributes)
+                context.update(body: body, attributes: attributes, )
               end
 
               ##