twilio-ruby 7.9.1 → 7.10.0

data/lib/twilio-ruby/rest/insights/v1/call/annotation.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [AnnotationList] AnnotationList
                     def initialize(version, call_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { call_sid: call_sid }
                         
@@ -50,6 +51,7 @@ module Twilio
                     # @return [AnnotationContext] AnnotationContext
                     def initialize(version, call_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { call_sid: call_sid,  }
@@ -76,6 +78,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the AnnotationInstanceMetadata
+                    # @return [AnnotationInstance] Fetched AnnotationInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        annotation_instance = AnnotationInstance.new(
+                            @version,
+                            response.body,
+                            call_sid: @solution[:call_sid],
+                        )
+                        AnnotationInstanceMetadata.new(
+                            @version,
+                            annotation_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the AnnotationInstance
                     # @param [AnsweredBy] answered_by 
@@ -120,6 +147,56 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the AnnotationInstanceMetadata
+                    # @param [AnsweredBy] answered_by 
+                    # @param [ConnectivityIssue] connectivity_issue 
+                    # @param [String] quality_issues Specify if the call had any subjective quality issues. Possible values, one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. Use comma separated values to indicate multiple quality issues for the same call.
+                    # @param [Boolean] spam A boolean flag to indicate if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Use `true` if the call was a spam call.
+                    # @param [String] call_score Specify the call score. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
+                    # @param [String] comment Specify any comments pertaining to the call. `comment` has a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in the `comment`.
+                    # @param [String] incident Associate this call with an incident or support ticket. The `incident` parameter is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`.
+                    # @return [AnnotationInstance] Updated AnnotationInstance
+                    def update_with_metadata(
+                      answered_by: :unset, 
+                      connectivity_issue: :unset, 
+                      quality_issues: :unset, 
+                      spam: :unset, 
+                      call_score: :unset, 
+                      comment: :unset, 
+                      incident: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'AnsweredBy' => answered_by,
+                            'ConnectivityIssue' => connectivity_issue,
+                            'QualityIssues' => quality_issues,
+                            'Spam' => spam,
+                            'CallScore' => call_score,
+                            'Comment' => comment,
+                            'Incident' => incident,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        annotation_instance = AnnotationInstance.new(
+                            @version,
+                            response.body,
+                            call_sid: @solution[:call_sid],
+                        )
+                        AnnotationInstanceMetadata.new(
+                            @version,
+                            annotation_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -136,6 +213,53 @@ module Twilio
                     end
                 end
 
+                class AnnotationInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new AnnotationInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}AnnotationInstance] annotation_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 [AnnotationInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, annotation_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @annotation_instance = annotation_instance
+                    end
+
+                    def annotation
+                        @annotation_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.AnnotationInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class AnnotationListResponse < InstanceListResource
+                    # @param [Array<AnnotationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @annotation_instance = payload.body[key].map do |data|
+                        AnnotationInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def annotation_instance
+                          @instance
+                      end
+                  end
+
                 class AnnotationPage < Page
                     ##
                     # Initialize the AnnotationPage
@@ -145,6 +269,7 @@ module Twilio
                     # @return [AnnotationPage] AnnotationPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -164,6 +289,66 @@ module Twilio
                         '<Twilio.Insights.V1.AnnotationPage>'
                     end
                 end
+
+                class AnnotationPageMetadata < PageMetadata
+                    attr_reader :annotation_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @annotation_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @annotation_page << AnnotationListResponse.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
+                        @annotation_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Insights::V1PageMetadata>';
+                    end
+                end
+                class AnnotationListResponse < InstanceListResource
+
+                    # @param [Array<AnnotationInstance>] 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
+                      @annotation = data_list.map do |data|
+                        AnnotationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def annotation
+                        @annotation
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class AnnotationInstance < InstanceResource
                     ##
                     # Initialize the AnnotationInstance
@@ -177,6 +362,7 @@ module Twilio
                     def initialize(version, payload , call_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'call_sid' => payload['call_sid'],

data/lib/twilio-ruby/rest/insights/v1/call/call_summary.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [CallSummaryList] CallSummaryList
                     def initialize(version, call_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { call_sid: call_sid }
                         
@@ -50,6 +51,7 @@ module Twilio
                     # @return [CallSummaryContext] CallSummaryContext
                     def initialize(version, call_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { call_sid: call_sid,  }
@@ -82,6 +84,37 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the CallSummaryInstanceMetadata
+                    # @param [ProcessingState] processing_state The Processing State of this Call Summary. One of `complete`, `partial` or `all`.
+                    # @return [CallSummaryInstance] Fetched CallSummaryInstance
+                    def fetch_with_metadata(
+                      processing_state: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'ProcessingState' => processing_state,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        call_summary_instance = CallSummaryInstance.new(
+                            @version,
+                            response.body,
+                            call_sid: @solution[:call_sid],
+                        )
+                        CallSummaryInstanceMetadata.new(
+                            @version,
+                            call_summary_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -98,6 +131,53 @@ module Twilio
                     end
                 end
 
+                class CallSummaryInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new CallSummaryInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}CallSummaryInstance] call_summary_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 [CallSummaryInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, call_summary_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @call_summary_instance = call_summary_instance
+                    end
+
+                    def call_summary
+                        @call_summary_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.CallSummaryInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class CallSummaryListResponse < InstanceListResource
+                    # @param [Array<CallSummaryInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @call_summary_instance = payload.body[key].map do |data|
+                        CallSummaryInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def call_summary_instance
+                          @instance
+                      end
+                  end
+
                 class CallSummaryPage < Page
                     ##
                     # Initialize the CallSummaryPage
@@ -107,6 +187,7 @@ module Twilio
                     # @return [CallSummaryPage] CallSummaryPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -126,6 +207,66 @@ module Twilio
                         '<Twilio.Insights.V1.CallSummaryPage>'
                     end
                 end
+
+                class CallSummaryPageMetadata < PageMetadata
+                    attr_reader :call_summary_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @call_summary_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @call_summary_page << CallSummaryListResponse.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
+                        @call_summary_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Insights::V1PageMetadata>';
+                    end
+                end
+                class CallSummaryListResponse < InstanceListResource
+
+                    # @param [Array<CallSummaryInstance>] 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
+                      @call_summary = data_list.map do |data|
+                        CallSummaryInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def call_summary
+                        @call_summary
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class CallSummaryInstance < InstanceResource
                     ##
                     # Initialize the CallSummaryInstance
@@ -139,6 +280,7 @@ module Twilio
                     def initialize(version, payload , call_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

data/lib/twilio-ruby/rest/insights/v1/call/event.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [EventList] EventList
                     def initialize(version, call_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { call_sid: call_sid }
                         @uri = "/Voice/#{@solution[:call_sid]}/Events"
@@ -75,6 +76,30 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists EventPageMetadata records from the API as a list.
+                      # @param [TwilioEdge] edge The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
+                    # @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(edge: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Edge' => edge,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        EventPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields EventInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -97,7 +122,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 EventInstance
-                    def page(edge: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(edge: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Edge' => edge,
                             'PageToken' => page_token,
@@ -143,6 +168,7 @@ module Twilio
                     # @return [EventPage] EventPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -162,6 +188,66 @@ module Twilio
                         '<Twilio.Insights.V1.EventPage>'
                     end
                 end
+
+                class EventPageMetadata < PageMetadata
+                    attr_reader :event_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @event_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @event_page << EventListResponse.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
+                        @event_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Insights::V1PageMetadata>';
+                    end
+                end
+                class EventListResponse < InstanceListResource
+
+                    # @param [Array<EventInstance>] 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
+                      @event = data_list.map do |data|
+                        EventInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def event
+                        @event
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class EventInstance < InstanceResource
                     ##
                     # Initialize the EventInstance
@@ -175,6 +261,7 @@ module Twilio
                     def initialize(version, payload , call_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'timestamp' => payload['timestamp'],

data/lib/twilio-ruby/rest/insights/v1/call/metric.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [MetricList] MetricList
                     def initialize(version, call_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { call_sid: call_sid }
                         @uri = "/Voice/#{@solution[:call_sid]}/Metrics"
@@ -79,6 +80,32 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists MetricPageMetadata records from the API as a list.
+                      # @param [TwilioEdge] edge The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
+                      # @param [StreamDirection] direction The Direction of this Metric. One of `unknown`, `inbound`, `outbound` or `both`.
+                    # @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(edge: :unset, direction: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Edge' => edge,
+                            'Direction' => direction,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        MetricPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields MetricInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -102,7 +129,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 MetricInstance
-                    def page(edge: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(edge: :unset, direction: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Edge' => edge,
                             'Direction' => direction,
@@ -149,6 +176,7 @@ module Twilio
                     # @return [MetricPage] MetricPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -168,6 +196,66 @@ module Twilio
                         '<Twilio.Insights.V1.MetricPage>'
                     end
                 end
+
+                class MetricPageMetadata < PageMetadata
+                    attr_reader :metric_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @metric_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @metric_page << MetricListResponse.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
+                        @metric_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Insights::V1PageMetadata>';
+                    end
+                end
+                class MetricListResponse < InstanceListResource
+
+                    # @param [Array<MetricInstance>] 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
+                      @metric = data_list.map do |data|
+                        MetricInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def metric
+                        @metric
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class MetricInstance < InstanceResource
                     ##
                     # Initialize the MetricInstance
@@ -181,6 +269,7 @@ module Twilio
                     def initialize(version, payload , call_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'timestamp' => payload['timestamp'],