twilio-ruby 6.8.0 → 7.10.7

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

@@ -18,12 +18,14 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 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/QualityManagement/Assessments/Comments"
@@ -40,13 +42,13 @@ module Twilio
                     # @param [String] authorization The Authorization HTTP request header
                     # @return [InsightsAssessmentsCommentInstance] Created InsightsAssessmentsCommentInstance
                     def create(
-                        category_id: nil, 
-                        category_name: nil, 
-                        comment: nil, 
-                        segment_id: nil, 
-                        agent_id: nil, 
-                        offset: nil, 
-                        authorization: :unset
+                      category_id: nil, 
+                      category_name: nil, 
+                      comment: nil, 
+                      segment_id: nil, 
+                      agent_id: nil, 
+                      offset: nil, 
+                      authorization: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -58,7 +60,12 @@ module Twilio
                             'Offset' => offset,
                         })
 
-                        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)
                         InsightsAssessmentsCommentInstance.new(
                             @version,
@@ -66,6 +73,54 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the InsightsAssessmentsCommentInstanceMetadata
+                    # @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] agent_id The id of the agent.
+                    # @param [Float] offset The offset
+                    # @param [String] authorization The Authorization HTTP request header
+                    # @return [InsightsAssessmentsCommentInstance] Created InsightsAssessmentsCommentInstance
+                    def create_with_metadata(
+                      category_id: nil, 
+                      category_name: nil, 
+                      comment: nil, 
+                      segment_id: nil, 
+                      agent_id: nil, 
+                      offset: nil, 
+                      authorization: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'CategoryId' => category_id,
+                            'CategoryName' => category_name,
+                            'Comment' => comment,
+                            'SegmentId' => segment_id,
+                            'AgentId' => agent_id,
+                            'Offset' => offset,
+                        })
+
+                        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_assessments_comment_instance = InsightsAssessmentsCommentInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        InsightsAssessmentsCommentInstanceMetadata.new(
+                            @version,
+                            insights_assessments_comment_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists InsightsAssessmentsCommentInstance records from the API as a list.
@@ -114,7 +169,39 @@ module Twilio
                             agent_id: agent_id,
                             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 InsightsAssessmentsCommentPageMetadata records from the API as a list.
+                      # @param [String] authorization The Authorization HTTP request header
+                      # @param [String] segment_id The id of the segment.
+                      # @param [String] agent_id The id of the agent.
+                    # @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, segment_id: :unset, agent_id: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Authorization' => authorization,
+                            'SegmentId' => segment_id,
+                            'AgentId' => agent_id,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        InsightsAssessmentsCommentPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -126,9 +213,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
 
                     ##
@@ -141,7 +232,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 InsightsAssessmentsCommentInstance
-                    def page(authorization: :unset, segment_id: :unset, agent_id: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(authorization: :unset, segment_id: :unset, agent_id: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Authorization' => authorization,
                             'SegmentId' => segment_id,
@@ -150,8 +241,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)
 
                         InsightsAssessmentsCommentPage.new(@version, response, @solution)
                     end
@@ -186,6 +280,7 @@ module Twilio
                     # @return [InsightsAssessmentsCommentPage] InsightsAssessmentsCommentPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -205,6 +300,66 @@ module Twilio
                         '<Twilio.FlexApi.V1.InsightsAssessmentsCommentPage>'
                     end
                 end
+
+                class InsightsAssessmentsCommentPageMetadata < PageMetadata
+                    attr_reader :insights_assessments_comment_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @insights_assessments_comment_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @insights_assessments_comment_page << InsightsAssessmentsCommentListResponse.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_assessments_comment_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::FlexApi::V1PageMetadata>';
+                    end
+                end
+                class InsightsAssessmentsCommentListResponse < InstanceListResource
+
+                    # @param [Array<InsightsAssessmentsCommentInstance>] 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_assessments_comment = data_list.map do |data|
+                        InsightsAssessmentsCommentInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def insights_assessments_comment
+                        @insights_assessments_comment
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class InsightsAssessmentsCommentInstance < InstanceResource
                     ##
                     # Initialize the InsightsAssessmentsCommentInstance
@@ -218,6 +373,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -255,7 +411,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Float] The offset
+                    # @return [String] The offset
                     def offset
                         @properties['offset']
                     end
@@ -267,7 +423,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Float] The weightage given to this comment
+                    # @return [String] The weightage given to this comment
                     def weight
                         @properties['weight']
                     end
@@ -297,7 +453,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Float] The timestamp when the record is inserted
+                    # @return [String] The timestamp when the record is inserted
                     def timestamp
                         @properties['timestamp']
                     end

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

@@ -18,12 +18,14 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 class InsightsConversationsList < ListResource
+                
                     ##
                     # Initialize the InsightsConversationsList
                     # @param [Version] version Version that contains the resource
                     # @return [InsightsConversationsList] InsightsConversationsList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Insights/Conversations"
@@ -73,7 +75,37 @@ module Twilio
                             segment_id: segment_id,
                             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 InsightsConversationsPageMetadata records from the API as a list.
+                      # @param [String] authorization The Authorization HTTP request header
+                      # @param [String] segment_id Unique Id of the segment for which conversation details needs to be fetched
+                    # @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, segment_id: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Authorization' => authorization,
+                            'SegmentId' => segment_id,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        InsightsConversationsPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -85,9 +117,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
 
                     ##
@@ -99,7 +135,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 InsightsConversationsInstance
-                    def page(authorization: :unset, segment_id: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(authorization: :unset, segment_id: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Authorization' => authorization,
                             'SegmentId' => segment_id,
@@ -107,8 +143,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)
 
                         InsightsConversationsPage.new(@version, response, @solution)
                     end
@@ -143,6 +182,7 @@ module Twilio
                     # @return [InsightsConversationsPage] InsightsConversationsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -162,6 +202,66 @@ module Twilio
                         '<Twilio.FlexApi.V1.InsightsConversationsPage>'
                     end
                 end
+
+                class InsightsConversationsPageMetadata < PageMetadata
+                    attr_reader :insights_conversations_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @insights_conversations_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @insights_conversations_page << InsightsConversationsListResponse.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_conversations_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::FlexApi::V1PageMetadata>';
+                    end
+                end
+                class InsightsConversationsListResponse < InstanceListResource
+
+                    # @param [Array<InsightsConversationsInstance>] 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_conversations = data_list.map do |data|
+                        InsightsConversationsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def insights_conversations
+                        @insights_conversations
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class InsightsConversationsInstance < InstanceResource
                     ##
                     # Initialize the InsightsConversationsInstance
@@ -175,6 +275,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_id' => payload['account_id'],