twilio-ruby 5.19.0 → 5.77.0

data/lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb

@@ -0,0 +1,394 @@
+##
+# 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 InsightsQuestionnairesList < ListResource
+          ##
+          # Initialize the InsightsQuestionnairesList
+          # @param [Version] version Version that contains the resource
+          # @return [InsightsQuestionnairesList] InsightsQuestionnairesList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Insights/QM/Questionnaires"
+          end
+
+          ##
+          # Create the InsightsQuestionnairesInstance
+          # @param [String] name The name of this questionnaire
+          # @param [String] description The description of this questionnaire
+          # @param [Boolean] active The flag to enable or disable questionnaire
+          # @param [Array[String]] question_ids The list of questions ids under a
+          #   questionnaire
+          # @param [String] token The Token HTTP request header
+          # @return [InsightsQuestionnairesInstance] Created InsightsQuestionnairesInstance
+          def create(name: nil, description: :unset, active: :unset, question_ids: :unset, token: :unset)
+            data = Twilio::Values.of({
+                'Name' => name,
+                'Description' => description,
+                'Active' => active,
+                'QuestionIds' => Twilio.serialize_list(question_ids) { |e| e },
+            })
+            headers = Twilio::Values.of({'Token' => token, })
+
+            payload = @version.create('POST', @uri, data: data, headers: headers)
+
+            InsightsQuestionnairesInstance.new(@version, payload, )
+          end
+
+          ##
+          # Lists InsightsQuestionnairesInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [Boolean] include_inactive Flag indicating whether to include inactive
+          #   questionnaires or not
+          # @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(include_inactive: :unset, token: :unset, limit: nil, page_size: nil)
+            self.stream(
+                include_inactive: include_inactive,
+                token: token,
+                limit: limit,
+                page_size: page_size
+            ).entries
+          end
+
+          ##
+          # Streams InsightsQuestionnairesInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [Boolean] include_inactive Flag indicating whether to include inactive
+          #   questionnaires or not
+          # @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(include_inactive: :unset, token: :unset, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(include_inactive: include_inactive, token: token, page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields InsightsQuestionnairesInstance 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 InsightsQuestionnairesInstance records from the API.
+          # Request is executed immediately.
+          # @param [Boolean] include_inactive Flag indicating whether to include inactive
+          #   questionnaires or not
+          # @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 InsightsQuestionnairesInstance
+          def page(include_inactive: :unset, token: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'IncludeInactive' => include_inactive,
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+            headers = Twilio::Values.of({'Token' => token, })
+
+            response = @version.page('GET', @uri, params: params, headers: headers)
+
+            InsightsQuestionnairesPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of InsightsQuestionnairesInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of InsightsQuestionnairesInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            InsightsQuestionnairesPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.FlexApi.V1.InsightsQuestionnairesList>'
+          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 InsightsQuestionnairesPage < Page
+          ##
+          # Initialize the InsightsQuestionnairesPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [InsightsQuestionnairesPage] InsightsQuestionnairesPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of InsightsQuestionnairesInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [InsightsQuestionnairesInstance] InsightsQuestionnairesInstance
+          def get_instance(payload)
+            InsightsQuestionnairesInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.FlexApi.V1.InsightsQuestionnairesPage>'
+          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 InsightsQuestionnairesContext < InstanceContext
+          ##
+          # Initialize the InsightsQuestionnairesContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] id The unique ID of the questionnaire
+          # @return [InsightsQuestionnairesContext] InsightsQuestionnairesContext
+          def initialize(version, id)
+            super(version)
+
+            # Path Solution
+            @solution = {id: id, }
+            @uri = "/Insights/QM/Questionnaires/#{@solution[:id]}"
+          end
+
+          ##
+          # Update the InsightsQuestionnairesInstance
+          # @param [Boolean] active The flag to enable or disable questionnaire
+          # @param [String] name The name of this questionnaire
+          # @param [String] description The description of this questionnaire
+          # @param [Array[String]] question_ids The list of questions ids under a
+          #   questionnaire
+          # @param [String] token The Token HTTP request header
+          # @return [InsightsQuestionnairesInstance] Updated InsightsQuestionnairesInstance
+          def update(active: nil, name: :unset, description: :unset, question_ids: :unset, token: :unset)
+            data = Twilio::Values.of({
+                'Active' => active,
+                'Name' => name,
+                'Description' => description,
+                'QuestionIds' => Twilio.serialize_list(question_ids) { |e| e },
+            })
+            headers = Twilio::Values.of({'Token' => token, })
+
+            payload = @version.update('POST', @uri, data: data, headers: headers)
+
+            InsightsQuestionnairesInstance.new(@version, payload, id: @solution[:id], )
+          end
+
+          ##
+          # Delete the InsightsQuestionnairesInstance
+          # @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
+
+          ##
+          # Fetch the InsightsQuestionnairesInstance
+          # @param [String] token The Token HTTP request header
+          # @return [InsightsQuestionnairesInstance] Fetched InsightsQuestionnairesInstance
+          def fetch(token: :unset)
+            headers = Twilio::Values.of({'Token' => token, })
+
+            payload = @version.fetch('GET', @uri, headers: headers)
+
+            InsightsQuestionnairesInstance.new(@version, payload, id: @solution[:id], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FlexApi.V1.InsightsQuestionnairesContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FlexApi.V1.InsightsQuestionnairesContext #{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 InsightsQuestionnairesInstance < InstanceResource
+          ##
+          # Initialize the InsightsQuestionnairesInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] id The unique ID of the questionnaire
+          # @return [InsightsQuestionnairesInstance] InsightsQuestionnairesInstance
+          def initialize(version, payload, id: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'id' => payload['id'],
+                'name' => payload['name'],
+                'description' => payload['description'],
+                'active' => payload['active'],
+                'questions' => payload['questions'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'id' => id || @properties['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 [InsightsQuestionnairesContext] InsightsQuestionnairesContext for this InsightsQuestionnairesInstance
+          def context
+            unless @instance_context
+              @instance_context = InsightsQuestionnairesContext.new(@version, @params['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] The questionnaire id
+          def id
+            @properties['id']
+          end
+
+          ##
+          # @return [String] The category name.
+          def name
+            @properties['name']
+          end
+
+          ##
+          # @return [String] The questionnaire description
+          def description
+            @properties['description']
+          end
+
+          ##
+          # @return [Boolean] Is questionnaire enabled ?
+          def active
+            @properties['active']
+          end
+
+          ##
+          # @return [Array[Hash]] The questions list
+          def questions
+            @properties['questions']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Update the InsightsQuestionnairesInstance
+          # @param [Boolean] active The flag to enable or disable questionnaire
+          # @param [String] name The name of this questionnaire
+          # @param [String] description The description of this questionnaire
+          # @param [Array[String]] question_ids The list of questions ids under a
+          #   questionnaire
+          # @param [String] token The Token HTTP request header
+          # @return [InsightsQuestionnairesInstance] Updated InsightsQuestionnairesInstance
+          def update(active: nil, name: :unset, description: :unset, question_ids: :unset, token: :unset)
+            context.update(
+                active: active,
+                name: name,
+                description: description,
+                question_ids: question_ids,
+                token: token,
+            )
+          end
+
+          ##
+          # Delete the InsightsQuestionnairesInstance
+          # @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
+
+          ##
+          # Fetch the InsightsQuestionnairesInstance
+          # @param [String] token The Token HTTP request header
+          # @return [InsightsQuestionnairesInstance] Fetched InsightsQuestionnairesInstance
+          def fetch(token: :unset)
+            context.fetch(token: token, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FlexApi.V1.InsightsQuestionnairesInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FlexApi.V1.InsightsQuestionnairesInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end