##
# 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 InsightsQuestionnairesCategoryList < ListResource
          ##
          # Initialize the InsightsQuestionnairesCategoryList
          # @param [Version] version Version that contains the resource
          # @return [InsightsQuestionnairesCategoryList] InsightsQuestionnairesCategoryList
          def initialize(version)
            super(version)

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

          ##
          # Create the InsightsQuestionnairesCategoryInstance
          # @param [String] name The name of this category.
          # @param [String] token The Token HTTP request header
          # @return [InsightsQuestionnairesCategoryInstance] Created InsightsQuestionnairesCategoryInstance
          def create(name: nil, token: :unset)
            data = Twilio::Values.of({'Name' => name, })
            headers = Twilio::Values.of({'Token' => token, })

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

            InsightsQuestionnairesCategoryInstance.new(@version, payload, )
          end

          ##
          # Lists InsightsQuestionnairesCategoryInstance records from the API as a list.
          # Unlike stream(), this operation is eager and will load `limit` records into
          # memory before returning.
          # @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(token: :unset, limit: nil, page_size: nil)
            self.stream(token: token, limit: limit, page_size: page_size).entries
          end

          ##
          # Streams InsightsQuestionnairesCategoryInstance records from the API as an Enumerable.
          # This operation lazily loads records as efficiently as possible until the limit
          # is reached.
          # @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(token: :unset, limit: nil, page_size: nil)
            limits = @version.read_limits(limit, page_size)

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

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

          ##
          # When passed a block, yields InsightsQuestionnairesCategoryInstance 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 InsightsQuestionnairesCategoryInstance records from the API.
          # Request is executed immediately.
          # @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 InsightsQuestionnairesCategoryInstance
          def page(token: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
            params = Twilio::Values.of({
                'PageToken' => page_token,
                'Page' => page_number,
                'PageSize' => page_size,
            })
            headers = Twilio::Values.of({'Token' => token, })

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

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

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

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

            # Path Solution
            @solution = solution
          end

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

          ##
          # Provide a user friendly representation
          def to_s
            '<Twilio.FlexApi.V1.InsightsQuestionnairesCategoryPage>'
          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 InsightsQuestionnairesCategoryContext < InstanceContext
          ##
          # Initialize the InsightsQuestionnairesCategoryContext
          # @param [Version] version Version that contains the resource
          # @param [String] category_id The ID of the category to be update
          # @return [InsightsQuestionnairesCategoryContext] InsightsQuestionnairesCategoryContext
          def initialize(version, category_id)
            super(version)

            # Path Solution
            @solution = {category_id: category_id, }
            @uri = "/Insights/QM/Categories/#{@solution[:category_id]}"
          end

          ##
          # Update the InsightsQuestionnairesCategoryInstance
          # @param [String] name The name of this category.
          # @param [String] token The Token HTTP request header
          # @return [InsightsQuestionnairesCategoryInstance] Updated InsightsQuestionnairesCategoryInstance
          def update(name: nil, token: :unset)
            data = Twilio::Values.of({'Name' => name, })
            headers = Twilio::Values.of({'Token' => token, })

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

            InsightsQuestionnairesCategoryInstance.new(@version, payload, category_id: @solution[:category_id], )
          end

          ##
          # Delete the InsightsQuestionnairesCategoryInstance
          # @param [String] token The Token HTTP request header
          # @return [Boolean] true if delete succeeds, false otherwise
          def delete(token: :unset)
            headers = Twilio::Values.of({'Token' => token, })

             @version.delete('DELETE', @uri, headers: headers)
          end

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

          ##
          # Provide a detailed, user friendly representation
          def inspect
            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
            "#<Twilio.FlexApi.V1.InsightsQuestionnairesCategoryContext #{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 InsightsQuestionnairesCategoryInstance < InstanceResource
          ##
          # Initialize the InsightsQuestionnairesCategoryInstance
          # @param [Version] version Version that contains the resource
          # @param [Hash] payload payload that contains response from Twilio
          # @param [String] category_id The ID of the category to be update
          # @return [InsightsQuestionnairesCategoryInstance] InsightsQuestionnairesCategoryInstance
          def initialize(version, payload, category_id: nil)
            super(version)

            # Marshaled Properties
            @properties = {
                'account_sid' => payload['account_sid'],
                'category_id' => payload['category_id'],
                'name' => payload['name'],
                'url' => payload['url'],
            }

            # Context
            @instance_context = nil
            @params = {'category_id' => category_id || @properties['category_id'], }
          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 [InsightsQuestionnairesCategoryContext] InsightsQuestionnairesCategoryContext for this InsightsQuestionnairesCategoryInstance
          def context
            unless @instance_context
              @instance_context = InsightsQuestionnairesCategoryContext.new(@version, @params['category_id'], )
            end
            @instance_context
          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] Unique category ID
          def category_id
            @properties['category_id']
          end

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

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

          ##
          # Update the InsightsQuestionnairesCategoryInstance
          # @param [String] name The name of this category.
          # @param [String] token The Token HTTP request header
          # @return [InsightsQuestionnairesCategoryInstance] Updated InsightsQuestionnairesCategoryInstance
          def update(name: nil, token: :unset)
            context.update(name: name, token: token, )
          end

          ##
          # Delete the InsightsQuestionnairesCategoryInstance
          # @param [String] token The Token HTTP request header
          # @return [Boolean] true if delete succeeds, false otherwise
          def delete(token: :unset)
            context.delete(token: token, )
          end

          ##
          # Provide a user friendly representation
          def to_s
            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
            "<Twilio.FlexApi.V1.InsightsQuestionnairesCategoryInstance #{values}>"
          end

          ##
          # Provide a detailed, user friendly representation
          def inspect
            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
            "<Twilio.FlexApi.V1.InsightsQuestionnairesCategoryInstance #{values}>"
          end
        end
      end
    end
  end
end