twilio-ruby 5.6.0 → 5.33.0

data/lib/twilio-ruby/rest/chat/v2/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/chat/rest/service-resource) the Message
+              #   resource is associated with.
+              # @param [String] channel_sid The SID of the
+              #   [Channel](https://www.twilio.com/docs/chat/channels) the Message resource
+              #   belongs to.
               # @return [MessageList] MessageList
               def initialize(version, service_sid: nil, channel_sid: nil)
                 super(version)
@@ -28,13 +34,27 @@ module Twilio
               ##
               # Retrieve a single page of MessageInstance records from the API.
               # Request is executed immediately.
-              # @param [String] from The from
-              # @param [String] attributes The attributes
-              # @param [Time] date_created The date_created
-              # @param [Time] date_updated The date_updated
-              # @param [String] last_updated_by The last_updated_by
-              # @param [String] body The body
-              # @param [String] media_sid The media_sid
+              # @param [String] from The [Identity](https://www.twilio.com/docs/chat/identity)
+              #   of the new message's author. The default value is `system`.
+              # @param [String] attributes A valid JSON string that contains
+              #   application-specific data.
+              # @param [Time] date_created The date, specified in [ISO
+              #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
+              #   as the date it was created. The default value is the current time set by the
+              #   Chat service. This parameter should only be used when a Chat's history is being
+              #   recreated from a backup/separate source.
+              # @param [Time] date_updated The date, specified in [ISO
+              #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
+              #   as the date it was last updated.
+              # @param [String] last_updated_by The
+              #   [Identity](https://www.twilio.com/docs/chat/identity) of the User who last
+              #   updated the Message, if applicable.
+              # @param [String] body The message to send to the channel. Can 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] media_sid The SID of the
+              #   [Media](https://www.twilio.com/docs/chat/rest/media) to attach to the new
+              #   Message.
               # @return [MessageInstance] Newly created MessageInstance
               def create(from: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, body: :unset, media_sid: :unset)
                 data = Twilio::Values.of({
@@ -65,7 +85,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
@@ -81,7 +102,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
@@ -92,7 +114,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
@@ -104,7 +126,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,7 +136,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
@@ -192,15 +215,20 @@ 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/chat/rest/service-resource) to fetch the
+              #   Message resource from.
+              # @param [String] channel_sid The SID of the
+              #   [Channel](https://www.twilio.com/docs/chat/channels) the Message resource to
+              #   fetch belongs to. This value can be the Channel resource's `sid` or
+              #   `unique_name`.
+              # @param [String] sid The SID of 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
 
@@ -227,26 +255,40 @@ module Twilio
 
               ##
               # Deletes the MessageInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
 
               ##
               # Update the MessageInstance
-              # @param [String] body The body
-              # @param [String] attributes The attributes
-              # @param [Time] date_created The date_created
-              # @param [Time] date_updated The date_updated
-              # @param [String] last_updated_by The last_updated_by
+              # @param [String] body The message to send to the channel. Can 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.
+              # @param [Time] date_created The date, specified in [ISO
+              #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
+              #   as the date it was created. The default value is the current time set by the
+              #   Chat service. This parameter should only be used when a Chat's history is being
+              #   recreated from a backup/separate source.
+              # @param [Time] date_updated The date, specified in [ISO
+              #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
+              #   as the date it was last updated.
+              # @param [String] last_updated_by The
+              #   [Identity](https://www.twilio.com/docs/chat/identity) of the User who last
+              #   updated the Message, if applicable.
+              # @param [String] from The [Identity](https://www.twilio.com/docs/chat/identity)
+              #   of the message's author.
               # @return [MessageInstance] Updated MessageInstance
-              def update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset)
+              def update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, from: :unset)
                 data = Twilio::Values.of({
                     'Body' => body,
                     'Attributes' => attributes,
                     'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
                     'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
                     'LastUpdatedBy' => last_updated_by,
+                    'From' => from,
                 })
 
                 payload = @version.update(
@@ -270,6 +312,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Chat.V2.MessageContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Chat.V2.MessageContext #{context}>"
+              end
             end
 
             class MessageInstance < InstanceResource
@@ -277,9 +326,13 @@ 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/chat/rest/service-resource) the Message
+              #   resource is associated with.
+              # @param [String] channel_sid The SID of the
+              #   [Channel](https://www.twilio.com/docs/chat/channels) the Message resource
+              #   belongs to.
+              # @param [String] sid The SID of the Message resource to fetch.
               # @return [MessageInstance] MessageInstance
               def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
                 super(version)
@@ -330,97 +383,97 @@ 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 SID 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 [String] The last_updated_by
+              # @return [String] The Identity of the User who last updated the Message
               def last_updated_by
                 @properties['last_updated_by']
               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 type
+              # @return [String] The Message type
               def type
                 @properties['type']
               end
 
               ##
-              # @return [Hash] The media
+              # @return [Hash] A Media object that describes the Message's media if attached; otherwise, null
               def media
                 @properties['media']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the Message resource
               def url
                 @properties['url']
               end
@@ -434,26 +487,40 @@ module Twilio
 
               ##
               # Deletes the MessageInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @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 [Time] date_created The date_created
-              # @param [Time] date_updated The date_updated
-              # @param [String] last_updated_by The last_updated_by
+              # @param [String] body The message to send to the channel. Can 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.
+              # @param [Time] date_created The date, specified in [ISO
+              #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
+              #   as the date it was created. The default value is the current time set by the
+              #   Chat service. This parameter should only be used when a Chat's history is being
+              #   recreated from a backup/separate source.
+              # @param [Time] date_updated The date, specified in [ISO
+              #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
+              #   as the date it was last updated.
+              # @param [String] last_updated_by The
+              #   [Identity](https://www.twilio.com/docs/chat/identity) of the User who last
+              #   updated the Message, if applicable.
+              # @param [String] from The [Identity](https://www.twilio.com/docs/chat/identity)
+              #   of the message's author.
               # @return [MessageInstance] Updated MessageInstance
-              def update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset)
+              def update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, from: :unset)
                 context.update(
                     body: body,
                     attributes: attributes,
                     date_created: date_created,
                     date_updated: date_updated,
                     last_updated_by: last_updated_by,
+                    from: from,
                 )
               end