twilio-ruby 7.10.7 → 7.11.2

data/lib/twilio-ruby/rest/insights/v2/outbound_report.rb

@@ -0,0 +1,258 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Sample/reference Twilio API.
+#    This is the reference API for the rest-proxy server.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Insights < InsightsBase
+            class V2 < Version
+                class OutboundReportList < ListResource
+                
+                    class InsightsV2CreatePhoneNumbersReportRequest
+                            # @param [time_range]: [InboundReportList.InsightsV2CreatePhoneNumbersReportRequestTimeRange] 
+                            # @param [filters]: [Array<InboundReportList.PhoneNumberReportFilter>] 
+                            # @param [size]: [String] The number of max available top Phone Numbers to generate.
+                        attr_accessor :time_range, :filters, :size
+                        def initialize(payload)
+                                @time_range = payload["time_range"]
+                                @filters = payload["filters"]
+                                @size = payload["size"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "time_range": @time_range,
+                                "filters": @filters,
+                                "size": @size,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class InsightsV2CreatePhoneNumbersReportRequestTimeRange
+                            # @param [start_datetime]: [Time] Start date time of the report
+                            # @param [end_datetime]: [Time] End date time of the report
+                        attr_accessor :start_datetime, :end_datetime
+                        def initialize(payload)
+                                @start_datetime = payload["start_datetime"]
+                                @end_datetime = payload["end_datetime"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "start_datetime": @start_datetime,
+                                "end_datetime": @end_datetime,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class PhoneNumberReportFilter
+                            # @param [key]: [String] The name of the filter 
+                            # @param [values]: [Array<String>] List of supported filter values for the field name
+                        attr_accessor :key, :values
+                        def initialize(payload)
+                                @key = payload["key"]
+                                @values = payload["values"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "key": @key,
+                                "values": @values,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ReportFilter
+                            # @param [key]: [String] The name of the filter 'call_state', 'call_direction', 'call_type', 'twilio_regions', 'caller_country_code', 'callee_country_code', 'silent' 
+                            # @param [values]: [Array<String>] List of supported filter values for the field name
+                        attr_accessor :key, :values
+                        def initialize(payload)
+                                @key = payload["key"]
+                                @values = payload["values"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "key": @key,
+                                "values": @values,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the OutboundReportList
+                    # @param [Version] version Version that contains the resource
+                    # @return [OutboundReportList] OutboundReportList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Voice/Reports/PhoneNumbers/Outbound"
+                        
+                    end
+                    ##
+                    # Create the OutboundReportInstance
+                    # @param [InsightsV2CreatePhoneNumbersReportRequest] insights_v2_create_phone_numbers_report_request 
+                    # @return [OutboundReportInstance] Created OutboundReportInstance
+                    def create(insights_v2_create_phone_numbers_report_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: insights_v2_create_phone_numbers_report_request.to_json)
+                        OutboundReportInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the OutboundReportInstanceMetadata
+                    # @param [InsightsV2CreatePhoneNumbersReportRequest] insights_v2_create_phone_numbers_report_request 
+                    # @return [OutboundReportInstance] Created OutboundReportInstance
+                    def create_with_metadata(insights_v2_create_phone_numbers_report_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: insights_v2_create_phone_numbers_report_request.to_json)
+                        outbound_report_instance = OutboundReportInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        OutboundReportInstanceMetadata.new(
+                            @version,
+                            outbound_report_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Insights.V2.OutboundReportList>'
+                    end
+                end
+
+                class OutboundReportPage < Page
+                    ##
+                    # Initialize the OutboundReportPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [OutboundReportPage] OutboundReportPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of OutboundReportInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [OutboundReportInstance] OutboundReportInstance
+                    def get_instance(payload)
+                        OutboundReportInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Insights.V2.OutboundReportPage>'
+                    end
+                end
+
+                class OutboundReportInstance < InstanceResource
+                    ##
+                    # Initialize the OutboundReportInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this OutboundReport
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [OutboundReportInstance] OutboundReportInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'account_sid' => payload['account_sid'],
+                            'report_id' => payload['report_id'],
+                            'status' => payload['status'],
+                            'request_meta' => payload['request_meta'],
+                            'url' => payload['url'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the Account.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The report identifier as Voice Insights Report TTID.
+                    def report_id
+                        @properties['report_id']
+                    end
+                    
+                    ##
+                    # @return [ReportStatus] 
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [ReportMetadata] 
+                    def request_meta
+                        @properties['request_meta']
+                    end
+                    
+                    ##
+                    # @return [String] The URL of this resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Insights.V2.OutboundReportInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Insights.V2.OutboundReportInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/insights/v2/report.rb

@@ -467,33 +467,7 @@ module Twilio
                         
                         # Path Solution
                         @solution = {  }
-                        
-                        
-                    end
-                
-
-
-                    # Provide a user friendly representation
-                    def to_s
-                        '#<Twilio.Insights.V2.ReportList>'
-                    end
-                end
-
-
-                class ReportContext < InstanceContext
-                    ##
-                    # Initialize the ReportContext
-                    # @param [Version] version Version that contains the resource
-                    # @param [String] report_id A unique request id.
-                    # @return [ReportContext] ReportContext
-                    def initialize(version, report_id)
-                        super(version)
-                        
-
-                        # Path Solution
-                        @solution = { report_id: report_id,  }
-                        @uri = "/Voice/Reports/#{@solution[:report_id]}"
-
+                        @uri = "/Voice/Reports"
                         
                     end
                     ##
@@ -513,7 +487,6 @@ module Twilio
                         ReportInstance.new(
                             @version,
                             payload,
-                            report_id: @solution[:report_id],
                         )
                     end
 
@@ -534,7 +507,6 @@ module Twilio
                         report_instance = ReportInstance.new(
                             @version,
                             response.body,
-                            report_id: @solution[:report_id],
                         )
                         ReportInstanceMetadata.new(
                             @version,
@@ -544,6 +516,32 @@ module Twilio
                         )
                     end
 
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Insights.V2.ReportList>'
+                    end
+                end
+
+
+                class ReportContext < InstanceContext
+                    ##
+                    # Initialize the ReportContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] report_id A unique request id.
+                    # @return [ReportContext] ReportContext
+                    def initialize(version, report_id)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = { report_id: report_id,  }
+                        @uri = "/Voice/Reports/#{@solution[:report_id]}"
+
+                        
+                    end
                     ##
                     # Fetch the ReportInstance
                     # @return [ReportInstance] Fetched ReportInstance
@@ -681,65 +679,6 @@ module Twilio
                     end
                 end
 
-                class ReportPageMetadata < PageMetadata
-                    attr_reader :report_page
-
-                    def initialize(version, response, solution, limit)
-                        super(version, response)
-                        @report_page = []
-                        @limit = limit
-                        key = get_key(response.body)
-                        records = 0
-                        while( limit != :unset && records < limit )
-                            @report_page << ReportListResponse.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
-                        @report_page.each do |record|
-                          yield record
-                        end
-                    end
-
-                    def to_s
-                      '<Twilio::REST::Insights::V2PageMetadata>';
-                    end
-                end
-                class ReportListResponse < InstanceListResource
-
-                    # @param [Array<ReportInstance>] 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
-                      @report = data_list.map do |data|
-                        ReportInstance.new(version, data)
-                      end
-                      @headers = payload.headers
-                      @status_code = payload.status_code
-                    end
-
-                    def report
-                        @report
-                    end
-
-                    def headers
-                      @headers
-                    end
-
-                    def status_code
-                      @status_code
-                    end
-                end
-
                 class ReportInstance < InstanceResource
                     ##
                     # Initialize the ReportInstance
@@ -761,18 +700,6 @@ module Twilio
                             'status' => payload['status'],
                             'request_meta' => payload['request_meta'],
                             'url' => payload['url'],
-                            'handle' => payload['handle'],
-                            'total_calls' => payload['total_calls'] == nil ? payload['total_calls'] : payload['total_calls'].to_i,
-                            'call_answer_score' => payload['call_answer_score'],
-                            'call_state_percentage' => payload['call_state_percentage'],
-                            'silent_calls_percentage' => payload['silent_calls_percentage'],
-                            'calls_by_device_type' => payload['calls_by_device_type'],
-                            'answer_rate_device_type' => payload['answer_rate_device_type'],
-                            'blocked_calls_by_carrier' => payload['blocked_calls_by_carrier'],
-                            'short_duration_calls_percentage' => payload['short_duration_calls_percentage'],
-                            'long_duration_calls_percentage' => payload['long_duration_calls_percentage'],
-                            'potential_robocalls_percentage' => payload['potential_robocalls_percentage'],
-                            'answering_machine_detection' => payload['answering_machine_detection'],
                             'report' => payload['report'],
                         }
 
@@ -822,96 +749,12 @@ module Twilio
                         @properties['url']
                     end
                     
-                    ##
-                    # @return [String] Inbound phone number handle represented in the report.
-                    def handle
-                        @properties['handle']
-                    end
-                    
-                    ##
-                    # @return [String] Total number of calls made with the given handle during the report period.
-                    def total_calls
-                        @properties['total_calls']
-                    end
-                    
-                    ##
-                    # @return [Float] The call answer score measures customers behavior to the delivered calls. The score is a value between 0 and 100, where 100 indicates that all calls were successfully answered. 
-                    def call_answer_score
-                        @properties['call_answer_score']
-                    end
-                    
-                    ##
-                    # @return [InsightsV2InboundPhoneNumberReportCallStatePercentage] 
-                    def call_state_percentage
-                        @properties['call_state_percentage']
-                    end
-                    
-                    ##
-                    # @return [Float] Percentage of inbound calls with silence tags over total outbound calls. A silent tag is indicative of a connectivity issue or muted audio.
-                    def silent_calls_percentage
-                        @properties['silent_calls_percentage']
-                    end
-                    
-                    ##
-                    # @return [Hash<String, Integer>] Number of calls made with each device type. `voip`, `mobile`, `landline`, `unknown` 
-                    def calls_by_device_type
-                        @properties['calls_by_device_type']
-                    end
-                    
-                    ##
-                    # @return [Hash<String, Float>] Answer rate for each device type. `voip`, `mobile`, `landline`, `unknown` 
-                    def answer_rate_device_type
-                        @properties['answer_rate_device_type']
-                    end
-                    
-                    ##
-                    # @return [Array<CountyCarrierValue>] Percentage of blocked calls by carrier per country.
-                    def blocked_calls_by_carrier
-                        @properties['blocked_calls_by_carrier']
-                    end
-                    
-                    ##
-                    # @return [Float] Percentage of completed outbound calls under 10 seconds (PSTN Short call tags); More than 15% is typically low trust measured.
-                    def short_duration_calls_percentage
-                        @properties['short_duration_calls_percentage']
-                    end
-                    
-                    ##
-                    # @return [Float] Percentage of long duration calls ( >= 60 seconds)
-                    def long_duration_calls_percentage
-                        @properties['long_duration_calls_percentage']
-                    end
-                    
-                    ##
-                    # @return [Float] Percentage of completed outbound calls to unassigned or unallocated phone numbers.
-                    def potential_robocalls_percentage
-                        @properties['potential_robocalls_percentage']
-                    end
-                    
-                    ##
-                    # @return [InsightsV2OutboundPhoneNumberReportAnsweringMachineDetection] 
-                    def answering_machine_detection
-                        @properties['answering_machine_detection']
-                    end
-                    
                     ##
                     # @return [AccountReport] 
                     def report
                         @properties['report']
                     end
                     
-                    ##
-                    # Create the ReportInstance
-                    # @param [InsightsV2CreateAccountReportRequest] insights_v2_create_account_report_request 
-                    # @return [ReportInstance] Created ReportInstance
-                    def create(insights_v2_create_account_report_request: :unset
-                    )
-
-                        context.create(
-                            insights_v2_create_account_report_request: insights_v2_create_account_report_request, 
-                        )
-                    end
-
                     ##
                     # Fetch the ReportInstance
                     # @return [ReportInstance] Fetched ReportInstance

data/lib/twilio-ruby/rest/insights/v2.rb

@@ -22,13 +22,14 @@ module Twilio
                     super
                     @version = 'v2'
                     @inbound = nil
+                    @inbound_reports = nil
                     @outbound = nil
+                    @outbound_reports = nil
                     @reports = nil
                 end
 
                 ##
                 # @param [String] report_id A unique Report Id.
-                # @return [Twilio::REST::Insights::V2::InboundContext] if reportId was passed.
                 # @return [Twilio::REST::Insights::V2::InboundList]
                 def inbound(report_id=:unset)
                     if report_id.nil?
@@ -38,12 +39,16 @@ module Twilio
                     if report_id == :unset
                         @inbound ||= InboundList.new self
                     else
-                        InboundContext.new(self, report_id)
+                        InboundList.new(self, report_id: report_id)
                     end
                 end
                 ##
+                # @return [Twilio::REST::Insights::V2::InboundReportList]
+                def inbound_reports
+                    @inbound_reports ||= InboundReportList.new self
+                end
+                ##
                 # @param [String] report_id A unique Report Id.
-                # @return [Twilio::REST::Insights::V2::OutboundContext] if reportId was passed.
                 # @return [Twilio::REST::Insights::V2::OutboundList]
                 def outbound(report_id=:unset)
                     if report_id.nil?
@@ -53,10 +58,15 @@ module Twilio
                     if report_id == :unset
                         @outbound ||= OutboundList.new self
                     else
-                        OutboundContext.new(self, report_id)
+                        OutboundList.new(self, report_id: report_id)
                     end
                 end
                 ##
+                # @return [Twilio::REST::Insights::V2::OutboundReportList]
+                def outbound_reports
+                    @outbound_reports ||= OutboundReportList.new self
+                end
+                ##
                 # @param [String] report_id A unique request id.
                 # @return [Twilio::REST::Insights::V2::ReportContext] if reportId was passed.
                 # @return [Twilio::REST::Insights::V2::ReportList]

data/lib/twilio-ruby/rest/insights/v3/metadata.rb

@@ -5,7 +5,7 @@
 #     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
 #
 #    Twilio - Insights
-#    Insights Domain V3 API.
+#    The Twilio Insights v3 API provides semantic query access to Conversations analytics data. Resources include synchronous Query, Metadata, and asynchronous QueryJobs for long-running queries. 
 #
 #    NOTE: This class is auto generated by OpenAPI Generator.
 #    https://openapi-generator.tech
@@ -114,65 +114,6 @@ module Twilio
                     end
                 end
 
-                class MetadataPageMetadata < PageMetadata
-                    attr_reader :metadata_page
-
-                    def initialize(version, response, solution, limit)
-                        super(version, response)
-                        @metadata_page = []
-                        @limit = limit
-                        key = get_key(response.body)
-                        records = 0
-                        while( limit != :unset && records < limit )
-                            @metadata_page << MetadataListResponse.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
-                        @metadata_page.each do |record|
-                          yield record
-                        end
-                    end
-
-                    def to_s
-                      '<Twilio::REST::Insights::V3PageMetadata>';
-                    end
-                end
-                class MetadataListResponse < InstanceListResource
-
-                    # @param [Array<MetadataInstance>] 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
-                      @metadata = data_list.map do |data|
-                        MetadataInstance.new(version, data)
-                      end
-                      @headers = payload.headers
-                      @status_code = payload.status_code
-                    end
-
-                    def metadata
-                        @metadata
-                    end
-
-                    def headers
-                      @headers
-                    end
-
-                    def status_code
-                      @status_code
-                    end
-                end
-
                 class MetadataInstance < InstanceResource
                     ##
                     # Initialize the MetadataInstance