twilio-ruby 6.8.0 → 7.10.7

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

@@ -18,12 +18,14 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 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/QualityManagement/Questionnaires"
@@ -38,11 +40,11 @@ module Twilio
                     # @param [String] authorization The Authorization HTTP request header
                     # @return [InsightsQuestionnairesInstance] Created InsightsQuestionnairesInstance
                     def create(
-                        name: nil, 
-                        description: :unset, 
-                        active: :unset, 
-                        question_sids: :unset, 
-                        authorization: :unset
+                      name: nil, 
+                      description: :unset, 
+                      active: :unset, 
+                      question_sids: :unset, 
+                      authorization: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -52,7 +54,12 @@ module Twilio
                             'QuestionSids' => Twilio.serialize_list(question_sids) { |e| e },
                         })
 
-                        headers = Twilio::Values.of({ 'Authorization' => authorization, })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => authorization, })
+                        
+                        
+                        
+                        
+                        
                         payload = @version.create('POST', @uri, data: data, headers: headers)
                         InsightsQuestionnairesInstance.new(
                             @version,
@@ -60,6 +67,48 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the InsightsQuestionnairesInstanceMetadata
+                    # @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_sids The list of questions sids under a questionnaire
+                    # @param [String] authorization The Authorization HTTP request header
+                    # @return [InsightsQuestionnairesInstance] Created InsightsQuestionnairesInstance
+                    def create_with_metadata(
+                      name: nil, 
+                      description: :unset, 
+                      active: :unset, 
+                      question_sids: :unset, 
+                      authorization: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Name' => name,
+                            'Description' => description,
+                            'Active' => active,
+                            'QuestionSids' => Twilio.serialize_list(question_sids) { |e| e },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => authorization, })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        insights_questionnaires_instance = InsightsQuestionnairesInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        InsightsQuestionnairesInstanceMetadata.new(
+                            @version,
+                            insights_questionnaires_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists InsightsQuestionnairesInstance records from the API as a list.
@@ -104,7 +153,37 @@ module Twilio
                             include_inactive: include_inactive,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists InsightsQuestionnairesPageMetadata records from the API as a list.
+                      # @param [String] authorization The Authorization HTTP request header
+                      # @param [Boolean] include_inactive Flag indicating whether to include inactive questionnaires or not
+                    # @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_with_metadata(authorization: :unset, include_inactive: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Authorization' => authorization,
+                            'IncludeInactive' => include_inactive,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        InsightsQuestionnairesPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -116,9 +195,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -130,7 +213,7 @@ module Twilio
                     # @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(authorization: :unset, include_inactive: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(authorization: :unset, include_inactive: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Authorization' => authorization,
                             'IncludeInactive' => include_inactive,
@@ -138,8 +221,11 @@ module Twilio
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         InsightsQuestionnairesPage.new(@version, response, @solution)
                     end
@@ -166,8 +252,6 @@ module Twilio
                 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
@@ -176,6 +260,7 @@ module Twilio
                     # @return [InsightsQuestionnairesContext] InsightsQuestionnairesContext
                     def initialize(version, questionnaire_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { questionnaire_sid: questionnaire_sid,  }
@@ -188,22 +273,53 @@ module Twilio
                     # @param [String] authorization The Authorization HTTP request header
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete(
-                        authorization: :unset
+                      authorization: :unset
                     )
 
-                        headers = Twilio::Values.of({ 'Authorization' => authorization, })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => authorization, })
+                        
+                        
+                        
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the InsightsQuestionnairesInstanceMetadata
+                    # @param [String] authorization The Authorization HTTP request header
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata(
+                      authorization: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => authorization, })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          insightsQuestionnaires_instance = InsightsQuestionnairesInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          InsightsQuestionnairesInstanceMetadata.new(@version, insightsQuestionnaires_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the InsightsQuestionnairesInstance
                     # @param [String] authorization The Authorization HTTP request header
                     # @return [InsightsQuestionnairesInstance] Fetched InsightsQuestionnairesInstance
                     def fetch(
-                        authorization: :unset
+                      authorization: :unset
                     )
 
-                        headers = Twilio::Values.of({ 'Authorization' => authorization, })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => authorization, })
+                        
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         InsightsQuestionnairesInstance.new(
                             @version,
@@ -212,6 +328,34 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the InsightsQuestionnairesInstanceMetadata
+                    # @param [String] authorization The Authorization HTTP request header
+                    # @return [InsightsQuestionnairesInstance] Fetched InsightsQuestionnairesInstance
+                    def fetch_with_metadata(
+                      authorization: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => authorization, })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        insights_questionnaires_instance = InsightsQuestionnairesInstance.new(
+                            @version,
+                            response.body,
+                            questionnaire_sid: @solution[:questionnaire_sid],
+                        )
+                        InsightsQuestionnairesInstanceMetadata.new(
+                            @version,
+                            insights_questionnaires_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the InsightsQuestionnairesInstance
                     # @param [Boolean] active The flag to enable or disable questionnaire
@@ -221,11 +365,11 @@ module Twilio
                     # @param [String] authorization The Authorization HTTP request header
                     # @return [InsightsQuestionnairesInstance] Updated InsightsQuestionnairesInstance
                     def update(
-                        active: nil, 
-                        name: :unset, 
-                        description: :unset, 
-                        question_sids: :unset, 
-                        authorization: :unset
+                      active: nil, 
+                      name: :unset, 
+                      description: :unset, 
+                      question_sids: :unset, 
+                      authorization: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -235,7 +379,12 @@ module Twilio
                             'QuestionSids' => Twilio.serialize_list(question_sids) { |e| e },
                         })
 
-                        headers = Twilio::Values.of({ 'Authorization' => authorization, })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => authorization, })
+                        
+                        
+                        
+                        
+                        
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         InsightsQuestionnairesInstance.new(
                             @version,
@@ -244,6 +393,49 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the InsightsQuestionnairesInstanceMetadata
+                    # @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_sids The list of questions sids under a questionnaire
+                    # @param [String] authorization The Authorization HTTP request header
+                    # @return [InsightsQuestionnairesInstance] Updated InsightsQuestionnairesInstance
+                    def update_with_metadata(
+                      active: nil, 
+                      name: :unset, 
+                      description: :unset, 
+                      question_sids: :unset, 
+                      authorization: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Active' => active,
+                            'Name' => name,
+                            'Description' => description,
+                            'QuestionSids' => Twilio.serialize_list(question_sids) { |e| e },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => authorization, })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        insights_questionnaires_instance = InsightsQuestionnairesInstance.new(
+                            @version,
+                            response.body,
+                            questionnaire_sid: @solution[:questionnaire_sid],
+                        )
+                        InsightsQuestionnairesInstanceMetadata.new(
+                            @version,
+                            insights_questionnaires_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -260,6 +452,53 @@ module Twilio
                     end
                 end
 
+                class InsightsQuestionnairesInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new InsightsQuestionnairesInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}InsightsQuestionnairesInstance] insights_questionnaires_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [InsightsQuestionnairesInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, insights_questionnaires_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @insights_questionnaires_instance = insights_questionnaires_instance
+                    end
+
+                    def insights_questionnaires
+                        @insights_questionnaires_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.InsightsQuestionnairesInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class InsightsQuestionnairesListResponse < InstanceListResource
+                    # @param [Array<InsightsQuestionnairesInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @insights_questionnaires_instance = payload.body[key].map do |data|
+                        InsightsQuestionnairesInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def insights_questionnaires_instance
+                          @instance
+                      end
+                  end
+
                 class InsightsQuestionnairesPage < Page
                     ##
                     # Initialize the InsightsQuestionnairesPage
@@ -269,6 +508,7 @@ module Twilio
                     # @return [InsightsQuestionnairesPage] InsightsQuestionnairesPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -288,6 +528,66 @@ module Twilio
                         '<Twilio.FlexApi.V1.InsightsQuestionnairesPage>'
                     end
                 end
+
+                class InsightsQuestionnairesPageMetadata < PageMetadata
+                    attr_reader :insights_questionnaires_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @insights_questionnaires_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @insights_questionnaires_page << InsightsQuestionnairesListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @insights_questionnaires_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::FlexApi::V1PageMetadata>';
+                    end
+                end
+                class InsightsQuestionnairesListResponse < InstanceListResource
+
+                    # @param [Array<InsightsQuestionnairesInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @insights_questionnaires = data_list.map do |data|
+                        InsightsQuestionnairesInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def insights_questionnaires
+                        @insights_questionnaires
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class InsightsQuestionnairesInstance < InstanceResource
                     ##
                     # Initialize the InsightsQuestionnairesInstance
@@ -301,6 +601,7 @@ module Twilio
                     def initialize(version, payload , questionnaire_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -375,7 +676,7 @@ module Twilio
                     # @param [String] authorization The Authorization HTTP request header
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete(
-                        authorization: :unset
+                      authorization: :unset
                     )
 
                         context.delete(
@@ -388,7 +689,7 @@ module Twilio
                     # @param [String] authorization The Authorization HTTP request header
                     # @return [InsightsQuestionnairesInstance] Fetched InsightsQuestionnairesInstance
                     def fetch(
-                        authorization: :unset
+                      authorization: :unset
                     )
 
                         context.fetch(
@@ -405,11 +706,11 @@ module Twilio
                     # @param [String] authorization The Authorization HTTP request header
                     # @return [InsightsQuestionnairesInstance] Updated InsightsQuestionnairesInstance
                     def update(
-                        active: nil, 
-                        name: :unset, 
-                        description: :unset, 
-                        question_sids: :unset, 
-                        authorization: :unset
+                      active: nil, 
+                      name: :unset, 
+                      description: :unset, 
+                      question_sids: :unset, 
+                      authorization: :unset
                     )
 
                         context.update(