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

module Twilio
  module REST
    class FlexApi < Domain
      class V1 < Version
        ##
        # 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 InsightsAssessmentsCommentList < ListResource
          ##
          # Initialize the InsightsAssessmentsCommentList
          # @param [Version] version Version that contains the resource
          # @return [InsightsAssessmentsCommentList] InsightsAssessmentsCommentList
          def initialize(version)
            super(version)

            # Path Solution
            @solution = {}
            @uri = "/Insights/QM/Assessments/Comments"
          end

          ##
          # Create the InsightsAssessmentsCommentInstance
          # @param [String] category_id The ID of the category
          # @param [String] category_name The name of the category
          # @param [String] comment The Assessment comment.
          # @param [String] segment_id The id of the segment.
          # @param [String] user_name The name of the user.
          # @param [String] user_email The email id of the user.
          # @param [String] agent_id The id of the agent.
          # @param [String] offset The offset
          # @param [String] token The Token HTTP request header
          # @return [InsightsAssessmentsCommentInstance] Created InsightsAssessmentsCommentInstance
          def create(category_id: nil, category_name: nil, comment: nil, segment_id: nil, user_name: nil, user_email: nil, agent_id: nil, offset: nil, token: :unset)
            data = Twilio::Values.of({
                'CategoryId' => category_id,
                'CategoryName' => category_name,
                'Comment' => comment,
                'SegmentId' => segment_id,
                'UserName' => user_name,
                'UserEmail' => user_email,
                'AgentId' => agent_id,
                'Offset' => offset,
            })
            headers = Twilio::Values.of({'Token' => token, })

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

            InsightsAssessmentsCommentInstance.new(@version, payload, )
          end

          ##
          # Lists InsightsAssessmentsCommentInstance records from the API as a list.
          # Unlike stream(), this operation is eager and will load `limit` records into
          # memory before returning.
          # @param [String] segment_id The id of the segment.
          # @param [String] agent_id The id of the agent.
          # @param [String] token The Token HTTP request header
          # @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(segment_id: :unset, agent_id: :unset, token: :unset, limit: nil, page_size: nil)
            self.stream(
                segment_id: segment_id,
                agent_id: agent_id,
                token: token,
                limit: limit,
                page_size: page_size
            ).entries
          end

          ##
          # Streams InsightsAssessmentsCommentInstance records from the API as an Enumerable.
          # This operation lazily loads records as efficiently as possible until the limit
          # is reached.
          # @param [String] segment_id The id of the segment.
          # @param [String] agent_id The id of the agent.
          # @param [String] token The Token HTTP request header
          # @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(segment_id: :unset, agent_id: :unset, token: :unset, limit: nil, page_size: nil)
            limits = @version.read_limits(limit, page_size)

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

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

          ##
          # When passed a block, yields InsightsAssessmentsCommentInstance 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 InsightsAssessmentsCommentInstance records from the API.
          # Request is executed immediately.
          # @param [String] segment_id The id of the segment.
          # @param [String] agent_id The id of the agent.
          # @param [String] token The Token HTTP request header
          # @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 InsightsAssessmentsCommentInstance
          def page(segment_id: :unset, agent_id: :unset, token: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
            params = Twilio::Values.of({
                'SegmentId' => segment_id,
                'AgentId' => agent_id,
                'PageToken' => page_token,
                'Page' => page_number,
                'PageSize' => page_size,
            })
            headers = Twilio::Values.of({'Token' => token, })

            response = @version.page('GET', @uri, params: params, headers: headers)

            InsightsAssessmentsCommentPage.new(@version, response, @solution)
          end

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

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

            # Path Solution
            @solution = solution
          end

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

          ##
          # Provide a user friendly representation
          def to_s
            '<Twilio.FlexApi.V1.InsightsAssessmentsCommentPage>'
          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 InsightsAssessmentsCommentInstance < InstanceResource
          ##
          # Initialize the InsightsAssessmentsCommentInstance
          # @param [Version] version Version that contains the resource
          # @param [Hash] payload payload that contains response from Twilio
          # @return [InsightsAssessmentsCommentInstance] InsightsAssessmentsCommentInstance
          def initialize(version, payload)
            super(version)

            # Marshaled Properties
            @properties = {
                'account_sid' => payload['account_sid'],
                'assessment_id' => payload['assessment_id'],
                'comment' => payload['comment'],
                'offset' => payload['offset'] == nil ? payload['offset'] : payload['offset'].to_f,
                'report' => payload['report'],
                'weight' => payload['weight'] == nil ? payload['weight'] : payload['weight'].to_f,
                'agent_id' => payload['agent_id'],
                'segment_id' => payload['segment_id'],
                'user_name' => payload['user_name'],
                'user_email' => payload['user_email'],
                'timestamp' => payload['timestamp'] == nil ? payload['timestamp'] : payload['timestamp'].to_f,
                'url' => payload['url'],
            }
          end

          ##
          # @return [String] The SID of the Account that created the resource and owns this Flex Insights
          def account_sid
            @properties['account_sid']
          end

          ##
          # @return [String] The Unique Assessment Id.
          def assessment_id
            @properties['assessment_id']
          end

          ##
          # @return [Hash] The assessment comment
          def comment
            @properties['comment']
          end

          ##
          # @return [String] Offset.
          def offset
            @properties['offset']
          end

          ##
          # @return [Boolean] Part of assessment report
          def report
            @properties['report']
          end

          ##
          # @return [String] The weightage
          def weight
            @properties['weight']
          end

          ##
          # @return [String] Agent Id.
          def agent_id
            @properties['agent_id']
          end

          ##
          # @return [String] Segment Id.
          def segment_id
            @properties['segment_id']
          end

          ##
          # @return [String] The user name.
          def user_name
            @properties['user_name']
          end

          ##
          # @return [String] The user email id.
          def user_email
            @properties['user_email']
          end

          ##
          # @return [String] The timestamp.
          def timestamp
            @properties['timestamp']
          end

          ##
          # @return [String] The url
          def url
            @properties['url']
          end

          ##
          # Provide a user friendly representation
          def to_s
            "<Twilio.FlexApi.V1.InsightsAssessmentsCommentInstance>"
          end

          ##
          # Provide a detailed, user friendly representation
          def inspect
            "<Twilio.FlexApi.V1.InsightsAssessmentsCommentInstance>"
          end
        end
      end
    end
  end
end