twilio-ruby 6.8.0 → 7.10.7

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

@@ -20,12 +20,14 @@ module Twilio
                 class CallContext < InstanceContext
 
                      class CallSummaryList < ListResource
+                
                     ##
                     # Initialize the CallSummaryList
                     # @param [Version] version Version that contains the resource
                     # @return [CallSummaryList] CallSummaryList
                     def initialize(version, call_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { call_sid: call_sid }
                         
@@ -49,6 +51,7 @@ module Twilio
                     # @return [CallSummaryContext] CallSummaryContext
                     def initialize(version, call_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { call_sid: call_sid,  }
@@ -61,13 +64,19 @@ module Twilio
                     # @param [ProcessingState] processing_state The Processing State of this Call Summary. One of `complete`, `partial` or `all`.
                     # @return [CallSummaryInstance] Fetched CallSummaryInstance
                     def fetch(
-                        processing_state: :unset
+                      processing_state: :unset
                     )
 
                         params = Twilio::Values.of({
                             'ProcessingState' => processing_state,
                         })
-                        payload = @version.fetch('GET', @uri, params: params)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
                         CallSummaryInstance.new(
                             @version,
                             payload,
@@ -75,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
@@ -91,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
@@ -100,6 +187,7 @@ module Twilio
                     # @return [CallSummaryPage] CallSummaryPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -119,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
@@ -132,6 +280,7 @@ module Twilio
                     def initialize(version, payload , call_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -242,37 +391,37 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Hash] The calling party.
+                    # @return [Hash] `object` The calling party. See [Details: Call Summary](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-summary#tofrom-object) for the object properties.
                     def from
                         @properties['from']
                     end
                     
                     ##
-                    # @return [Hash] The called party.
+                    # @return [Hash] `object` The called party. See [Details: Call Summary](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-summary#tofrom-object) for the object properties.
                     def to
                         @properties['to']
                     end
                     
                     ##
-                    # @return [Hash] Contains metrics and properties for the Twilio media gateway of a PSTN call.
+                    # @return [Hash] `object` Contains metrics and properties for the Twilio media gateway of a PSTN call. See [Details: Call Summary](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-summary#edges-and-their-properties) for the object properties.
                     def carrier_edge
                         @properties['carrier_edge']
                     end
                     
                     ##
-                    # @return [Hash] Contains metrics and properties for the Twilio media gateway of a Client call.
+                    # @return [Hash] `object` Contains metrics and properties for the Twilio media gateway of a Client call. See [Details: Call Summary](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-summary#edges-and-their-properties) for the object properties.
                     def client_edge
                         @properties['client_edge']
                     end
                     
                     ##
-                    # @return [Hash] Contains metrics and properties for the SDK sensor library for Client calls.
+                    # @return [Hash] `object` Contains metrics and properties for the SDK sensor library for Client calls. See [Details: Call Summary](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-summary#edges-and-their-properties) for the object properties.
                     def sdk_edge
                         @properties['sdk_edge']
                     end
                     
                     ##
-                    # @return [Hash] Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.
+                    # @return [Hash] `object` Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call. See [Details: Call Summary](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-summary#edges-and-their-properties) for the object properties.
                     def sip_edge
                         @properties['sip_edge']
                     end
@@ -290,25 +439,25 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Hash] Attributes capturing call-flow-specific details.
+                    # @return [Hash] `object` Attributes capturing call-flow-specific details. See [Details: Call Summary](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-summary#attributes-object) for the object properties.
                     def attributes
                         @properties['attributes']
                     end
                     
                     ##
-                    # @return [Hash] Contains edge-agnostic call-level details.
+                    # @return [Hash] `object` Contains edge-agnostic call-level details. See [Details: Call Summary](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-summary#properties-object) for the object properties.
                     def properties
                         @properties['properties']
                     end
                     
                     ##
-                    # @return [Hash] Contains trusted communications details including Branded Call and verified caller ID.
+                    # @return [Hash] `object` Contains trusted communications details including Branded Call and verified caller ID. See [Details: Call Summary](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-summary#trust-object) for the object properties.
                     def trust
                         @properties['trust']
                     end
                     
                     ##
-                    # @return [Hash] Programmatically labeled annotations for the Call. Developers can update the Call Summary records with Annotation during or after a Call. Annotations can be updated as long as the Call Summary record is addressable via the API.
+                    # @return [Hash] `object` Programmatically labeled annotations for the Call. Developers can update the Call Summary records with Annotation during or after a Call. Annotations can be updated as long as the Call Summary record is addressable via the API. See [Details: Call Summary](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-summary#annotation-object) for the object properties.
                     def annotation
                         @properties['annotation']
                     end
@@ -318,7 +467,7 @@ module Twilio
                     # @param [ProcessingState] processing_state The Processing State of this Call Summary. One of `complete`, `partial` or `all`.
                     # @return [CallSummaryInstance] Fetched CallSummaryInstance
                     def fetch(
-                        processing_state: :unset
+                      processing_state: :unset
                     )
 
                         context.fetch(

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

@@ -20,12 +20,14 @@ module Twilio
                 class CallContext < InstanceContext
 
                      class EventList < ListResource
+                
                     ##
                     # Initialize the EventList
                     # @param [Version] version Version that contains the resource
                     # @return [EventList] EventList
                     def initialize(version, call_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { call_sid: call_sid }
                         @uri = "/Voice/#{@solution[:call_sid]}/Events"
@@ -71,7 +73,35 @@ module Twilio
                             edge: edge,
                             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 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
 
                     ##
@@ -83,9 +113,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
 
                     ##
@@ -96,15 +130,18 @@ 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,
                             '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)
 
                         EventPage.new(@version, response, @solution)
                     end
@@ -139,6 +176,7 @@ module Twilio
                     # @return [EventPage] EventPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -158,6 +196,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
@@ -171,6 +269,7 @@ module Twilio
                     def initialize(version, payload , call_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'timestamp' => payload['timestamp'],
@@ -231,25 +330,25 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Hash] Represents the connection between Twilio and our immediate carrier partners. The events here describe the call lifecycle as reported by Twilio's carrier media gateways.
+                    # @return [Hash] `object` Represents the connection between Twilio and our immediate carrier partners. The events here describe the call lifecycle as reported by Twilio's carrier media gateways. See [Details: Call Summary](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-summary#edges-and-their-properties) for the object properties.
                     def carrier_edge
                         @properties['carrier_edge']
                     end
                     
                     ##
-                    # @return [Hash] Represents the Twilio media gateway for SIP interface and SIP trunking calls. The events here describe the call lifecycle as reported by Twilio's public media gateways.
+                    # @return [Hash] `object` Represents the Twilio media gateway for SIP interface and SIP trunking calls. The events here describe the call lifecycle as reported by Twilio's public media gateways. See [Details: Call Summary](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-summary#edges-and-their-properties) for the object properties.
                     def sip_edge
                         @properties['sip_edge']
                     end
                     
                     ##
-                    # @return [Hash] Represents the Voice SDK running locally in the browser or in the Android/iOS application. The events here are emitted by the Voice SDK in response to certain call progress events, network changes, or call quality conditions.
+                    # @return [Hash] `object` Represents the Voice SDK running locally in the browser or in the Android/iOS application. The events here are emitted by the Voice SDK in response to certain call progress events, network changes, or call quality conditions. See [Details: Call Summary](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-summary#edges-and-their-properties) for the object properties.
                     def sdk_edge
                         @properties['sdk_edge']
                     end
                     
                     ##
-                    # @return [Hash] Represents the Twilio media gateway for Client calls. The events here describe the call lifecycle as reported by Twilio's Voice SDK media gateways.
+                    # @return [Hash] `object` Represents the Twilio media gateway for Client calls. The events here describe the call lifecycle as reported by Twilio's Voice SDK media gateways. See [Details: Call Summary](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-summary#edges-and-their-properties) for the object properties.
                     def client_edge
                         @properties['client_edge']
                     end

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

@@ -20,12 +20,14 @@ module Twilio
                 class CallContext < InstanceContext
 
                      class MetricList < ListResource
+                
                     ##
                     # Initialize the MetricList
                     # @param [Version] version Version that contains the resource
                     # @return [MetricList] MetricList
                     def initialize(version, call_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { call_sid: call_sid }
                         @uri = "/Voice/#{@solution[:call_sid]}/Metrics"
@@ -75,7 +77,37 @@ module Twilio
                             direction: direction,
                             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 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
 
                     ##
@@ -87,9 +119,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
 
                     ##
@@ -101,7 +137,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,
@@ -109,8 +145,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)
 
                         MetricPage.new(@version, response, @solution)
                     end
@@ -145,6 +184,7 @@ module Twilio
                     # @return [MetricPage] MetricPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -164,6 +204,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
@@ -177,6 +277,7 @@ module Twilio
                     def initialize(version, payload , call_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'timestamp' => payload['timestamp'],