twilio-ruby 6.8.0 → 7.10.7

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

@@ -0,0 +1,650 @@
+##
+#    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 OutboundList < ListResource
+                
+                    class CountyCarrierValueCarriers
+                            # @param [carrier]: [String] The name of the carrier.
+                            # @param [total_calls]: [Integer] Total number of outbound calls for the carrier in the country.
+                            # @param [blocked_calls]: [Integer] Total number of blocked outbound calls for the carrier in the country.
+                            # @param [blocked_calls_percentage]: [Float] Percentage of blocked outbound calls for the carrier in the country.
+                        attr_accessor :carrier, :total_calls, :blocked_calls, :blocked_calls_percentage
+                        def initialize(payload)
+                                @carrier = payload["carrier"]
+                                @total_calls = payload["total_calls"]
+                                @blocked_calls = payload["blocked_calls"]
+                                @blocked_calls_percentage = payload["blocked_calls_percentage"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "carrier": @carrier,
+                                "total_calls": @total_calls,
+                                "blocked_calls": @blocked_calls,
+                                "blocked_calls_percentage": @blocked_calls_percentage,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class InsightsV2CreatePhoneNumbersReportRequest
+                            # @param [time_range]: [InboundList.InsightsV2CreatePhoneNumbersReportRequestTimeRange] 
+                            # @param [filters]: [Array<InboundList.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 OutboundList
+                    # @param [Version] version Version that contains the resource
+                    # @return [OutboundList] OutboundList
+                    def initialize(version, report_id: nil)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = { report_id: report_id }
+                        @uri = "/Voice/Reports/PhoneNumbers/Outbound/#{@solution[:report_id]}"
+                        
+                    end
+                
+                    ##
+                    # Lists OutboundInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @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(limit: nil, page_size: nil)
+                        self.stream(
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @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 [Enumerable] Enumerable that will yield up to limit results
+                    def stream(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            page_size: limits[:page_size], )
+
+                        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 OutboundPageMetadata records from the API as a list.
+                    # @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(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        OutboundPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields OutboundInstance records from the API.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    def each
+                        limits = @version.read_limits
+
+                        page = self.page(page_size: limits[:page_size], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
+                    end
+
+                    ##
+                    # Retrieve a single page of OutboundInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] page_token PageToken provided by the API
+                    # @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 OutboundInstance
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
+                        params = Twilio::Values.of({
+                            'PageToken' => page_token,
+                            'Page' => page_number,
+                            'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        OutboundPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of OutboundInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of OutboundInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    OutboundPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Insights.V2.OutboundList>'
+                    end
+                end
+
+
+                class OutboundContext < InstanceContext
+                    ##
+                    # Initialize the OutboundContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] report_id A unique Report Id.
+                    # @return [OutboundContext] OutboundContext
+                    def initialize(version, report_id)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = { report_id: report_id,  }
+                        @uri = "/Voice/Reports/PhoneNumbers/Outbound"
+
+                        
+                    end
+                    ##
+                    # Create the OutboundInstance
+                    # @param [InsightsV2CreatePhoneNumbersReportRequest] insights_v2_create_phone_numbers_report_request 
+                    # @return [OutboundInstance] Created OutboundInstance
+                    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)
+                        OutboundInstance.new(
+                            @version,
+                            payload,
+                            report_id: @solution[:report_id],
+                        )
+                    end
+
+                    ##
+                    # Create the OutboundInstanceMetadata
+                    # @param [InsightsV2CreatePhoneNumbersReportRequest] insights_v2_create_phone_numbers_report_request 
+                    # @return [OutboundInstance] Created OutboundInstance
+                    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_instance = OutboundInstance.new(
+                            @version,
+                            response.body,
+                            report_id: @solution[:report_id],
+                        )
+                        OutboundInstanceMetadata.new(
+                            @version,
+                            outbound_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Insights.V2.OutboundContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Insights.V2.OutboundContext #{context}>"
+                    end
+                end
+
+                class OutboundInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new OutboundInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}OutboundInstance] outbound_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 [OutboundInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, outbound_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @outbound_instance = outbound_instance
+                    end
+
+                    def outbound
+                        @outbound_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.OutboundInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class OutboundListResponse < InstanceListResource
+                    # @param [Array<OutboundInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @outbound_instance = payload.body[key].map do |data|
+                        OutboundInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def outbound_instance
+                          @instance
+                      end
+                  end
+
+                class OutboundPage < Page
+                    ##
+                    # Initialize the OutboundPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [OutboundPage] OutboundPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of OutboundInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [OutboundInstance] OutboundInstance
+                    def get_instance(payload)
+                        OutboundInstance.new(@version, payload, report_id: @solution[:report_id])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Insights.V2.OutboundPage>'
+                    end
+                end
+
+                class OutboundPageMetadata < PageMetadata
+                    attr_reader :outbound_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @outbound_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @outbound_page << OutboundListResponse.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
+                        @outbound_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Insights::V2PageMetadata>';
+                    end
+                end
+                class OutboundListResponse < InstanceListResource
+
+                    # @param [Array<OutboundInstance>] 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
+                      @outbound = data_list.map do |data|
+                        OutboundInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def outbound
+                        @outbound
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class OutboundInstance < InstanceResource
+                    ##
+                    # Initialize the OutboundInstance
+                    # @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 Outbound
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [OutboundInstance] OutboundInstance
+                    def initialize(version, payload , report_id: nil)
+                        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'],
+                            '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'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'report_id' => report_id  || @properties['report_id']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [OutboundContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = OutboundContext.new(@version , @params['report_id'])
+                        end
+                        @instance_context
+                    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
+                    
+                    ##
+                    # @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
+                    
+                    ##
+                    # Create the OutboundInstance
+                    # @param [InsightsV2CreatePhoneNumbersReportRequest] insights_v2_create_phone_numbers_report_request 
+                    # @return [OutboundInstance] Created OutboundInstance
+                    def create(insights_v2_create_phone_numbers_report_request: :unset
+                    )
+
+                        context.create(
+                            insights_v2_create_phone_numbers_report_request: insights_v2_create_phone_numbers_report_request, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Insights.V2.OutboundInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Insights.V2.OutboundInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end