##
# This code was generated by
# \ / _    _  _|   _  _
#  | (_)\/(_)(_|\/| |(/_  v1.0.0
#       /       /
#
# frozen_string_literal: true

module Twilio
  module REST
    class Messaging < 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 MessageList < ListResource
            ##
            # Initialize the MessageList
            # @param [Version] version Version that contains the resource
            # @param [String] session_sid The SID of the Session for the message.
            # @return [MessageList] MessageList
            def initialize(version, session_sid: nil)
              super(version)

              # Path Solution
              @solution = {session_sid: session_sid}
              @uri = "/Sessions/#{@solution[:session_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/chat/identity)
            #   of the message's author. Defaults to `system`.
            # @param [String] attributes A JSON string that stores 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.
            # @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] body The message body.
            # @return [MessageInstance] Newly created MessageInstance
            def create(author: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, body: :unset)
              data = Twilio::Values.of({
                  'Author' => author,
                  'Attributes' => attributes,
                  'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
                  'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
                  'Body' => body,
              })

              payload = @version.create(
                  'POST',
                  @uri,
                  data: data
              )

              MessageInstance.new(@version, payload, session_sid: @solution[:session_sid], )
            end

            ##
            # 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 [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
            #    not set will use the default value of 50 records.  If no page_size is defined
            #    but a limit is defined, stream() will attempt to read the limit with the most
            #    efficient page size, i.e. min(limit, 1000)
            # @return [Array] Array of up to limit results
            def list(limit: nil, page_size: nil)
              self.stream(limit: limit, page_size: page_size).entries
            end

            ##
            # Streams MessageInstance records from the API as an Enumerable.
            # This operation lazily loads records as efficiently as possible until the limit
            # is reached.
            # @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
            #    not set will use the default value of 50 records. If no page_size is defined
            #    but a limit is defined, stream() will attempt to read the limit with the most
            #    efficient page size, i.e. min(limit, 1000)
            # @return [Enumerable] Enumerable that will yield up to limit results
            def stream(limit: nil, page_size: nil)
              limits = @version.read_limits(limit, page_size)

              page = self.page(page_size: limits[:page_size], )

              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
            end

            ##
            # When passed a block, yields MessageInstance records from the API.
            # This operation lazily loads records as efficiently as possible until the limit
            # is reached.
            def each
              limits = @version.read_limits

              page = self.page(page_size: limits[:page_size], )

              @version.stream(page,
                              limit: limits[:limit],
                              page_limit: limits[:page_limit]).each {|x| yield x}
            end

            ##
            # Retrieve a single page of MessageInstance records from the API.
            # Request is executed immediately.
            # @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
            # @return [Page] Page of MessageInstance
            def page(page_token: :unset, page_number: :unset, page_size: :unset)
              params = Twilio::Values.of({
                  'PageToken' => page_token,
                  'Page' => page_number,
                  'PageSize' => page_size,
              })
              response = @version.page(
                  'GET',
                  @uri,
                  params
              )
              MessagePage.new(@version, response, @solution)
            end

            ##
            # Retrieve a single page of MessageInstance records from the API.
            # Request is executed immediately.
            # @param [String] target_url API-generated URL for the requested results page
            # @return [Page] Page of MessageInstance
            def get_page(target_url)
              response = @version.domain.request(
                  'GET',
                  target_url
              )
              MessagePage.new(@version, response, @solution)
            end

            ##
            # Provide a user friendly representation
            def to_s
              '#<Twilio.Messaging.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
            # @param [Version] version Version that contains the resource
            # @param [Response] response Response from the API
            # @param [Hash] solution Path solution for the resource
            # @return [MessagePage] MessagePage
            def initialize(version, response, solution)
              super(version, response)

              # Path Solution
              @solution = solution
            end

            ##
            # Build an instance of MessageInstance
            # @param [Hash] payload Payload response from the API
            # @return [MessageInstance] MessageInstance
            def get_instance(payload)
              MessageInstance.new(@version, payload, session_sid: @solution[:session_sid], )
            end

            ##
            # Provide a user friendly representation
            def to_s
              '<Twilio.Messaging.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 SID of the Session with the message to fetch.
            # @param [String] sid The SID of the SessionMessage resource to fetch.
            # @return [MessageContext] MessageContext
            def initialize(version, session_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,
              )

              MessageInstance.new(@version, payload, session_sid: @solution[:session_sid], sid: @solution[:sid], )
            end

            ##
            # Update the MessageInstance
            # @param [String] author The [identity](https://www.twilio.com/docs/chat/identity)
            #   of the message's author. Defaults to `system`.
            # @param [String] attributes A JSON string that stores 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.
            # @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] body The message body.
            # @return [MessageInstance] Updated MessageInstance
            def update(author: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, body: :unset)
              data = Twilio::Values.of({
                  'Author' => author,
                  'Attributes' => attributes,
                  'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
                  'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
                  'Body' => body,
              })

              payload = @version.update(
                  'POST',
                  @uri,
                  data: data,
              )

              MessageInstance.new(@version, payload, session_sid: @solution[:session_sid], sid: @solution[:sid], )
            end

            ##
            # Deletes the MessageInstance
            # @return [Boolean] true if delete succeeds, false otherwise
            def delete
              @version.delete('delete', @uri)
            end

            ##
            # Provide a user friendly representation
            def to_s
              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
              "#<Twilio.Messaging.V1.MessageContext #{context}>"
            end

            ##
            # Provide a detailed, user friendly representation
            def inspect
              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
              "#<Twilio.Messaging.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 SID of the Session for the message.
            # @param [String] sid The SID of the SessionMessage resource to fetch.
            # @return [MessageInstance] MessageInstance
            def initialize(version, payload, session_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'],
                  'sid' => payload['sid'],
                  'index' => payload['index'].to_i,
                  'author' => payload['author'],
                  'body' => payload['body'],
                  'attributes' => payload['attributes'],
                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                  'url' => payload['url'],
              }

              # Context
              @instance_context = nil
              @params = {'session_sid' => session_sid, 'sid' => sid || @properties['sid'], }
            end

            ##
            # Generate an instance context for the instance, the context is capable of
            # performing various actions.  All instance actions are proxied to the context
            # @return [MessageContext] MessageContext for this MessageInstance
            def context
              unless @instance_context
                @instance_context = MessageContext.new(@version, @params['session_sid'], @params['sid'], )
              end
              @instance_context
            end

            ##
            # @return [String] The SID of the Account that created the resource
            def account_sid
              @properties['account_sid']
            end

            ##
            # @return [String] The SID of the Service that the resource is associated with
            def service_sid
              @properties['service_sid']
            end

            ##
            # @return [String] The SID of the Messaging Service the message belongs to
            def messaging_service_sid
              @properties['messaging_service_sid']
            end

            ##
            # @return [String] The SID of the Session for the message
            def session_sid
              @properties['session_sid']
            end

            ##
            # @return [String] The unique string that identifies the resource
            def sid
              @properties['sid']
            end

            ##
            # @return [String] The index of the message within the Session
            def index
              @properties['index']
            end

            ##
            # @return [String] The identity or the address of the device of the message's author
            def author
              @properties['author']
            end

            ##
            # @return [String] The message body
            def body
              @properties['body']
            end

            ##
            # @return [String] The JSON string that stores application-specific data
            def attributes
              @properties['attributes']
            end

            ##
            # @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 ISO 8601 date and time in GMT when the resource was last updated
            def date_updated
              @properties['date_updated']
            end

            ##
            # @return [String] The absolute URL of the message
            def url
              @properties['url']
            end

            ##
            # Fetch a MessageInstance
            # @return [MessageInstance] Fetched MessageInstance
            def fetch
              context.fetch
            end

            ##
            # Update the MessageInstance
            # @param [String] author The [identity](https://www.twilio.com/docs/chat/identity)
            #   of the message's author. Defaults to `system`.
            # @param [String] attributes A JSON string that stores 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.
            # @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] body The message body.
            # @return [MessageInstance] Updated MessageInstance
            def update(author: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, body: :unset)
              context.update(
                  author: author,
                  attributes: attributes,
                  date_created: date_created,
                  date_updated: date_updated,
                  body: body,
              )
            end

            ##
            # Deletes the MessageInstance
            # @return [Boolean] true if delete succeeds, false otherwise
            def delete
              context.delete
            end

            ##
            # Provide a user friendly representation
            def to_s
              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
              "<Twilio.Messaging.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}>"
            end
          end
        end
      end
    end
  end
end