twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country/highrisk_special_prefix.rb

@@ -21,12 +21,14 @@ module Twilio
                 class CountryContext < InstanceContext
 
                      class HighriskSpecialPrefixList < ListResource
+                
                     ##
                     # Initialize the HighriskSpecialPrefixList
                     # @param [Version] version Version that contains the resource
                     # @return [HighriskSpecialPrefixList] HighriskSpecialPrefixList
                     def initialize(version, iso_code: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { iso_code: iso_code }
                         @uri = "/DialingPermissions/Countries/#{@solution[:iso_code]}/HighRiskSpecialPrefixes"
@@ -68,7 +70,33 @@ module Twilio
                         page = self.page(
                             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 HighriskSpecialPrefixPageMetadata 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)
+
+                        HighriskSpecialPrefixPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -80,9 +108,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
 
                     ##
@@ -92,14 +124,17 @@ 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 HighriskSpecialPrefixInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    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)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         HighriskSpecialPrefixPage.new(@version, response, @solution)
                     end
@@ -134,6 +169,7 @@ module Twilio
                     # @return [HighriskSpecialPrefixPage] HighriskSpecialPrefixPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -153,6 +189,66 @@ module Twilio
                         '<Twilio.Voice.V1.HighriskSpecialPrefixPage>'
                     end
                 end
+
+                class HighriskSpecialPrefixPageMetadata < PageMetadata
+                    attr_reader :highrisk_special_prefix_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @highrisk_special_prefix_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @highrisk_special_prefix_page << HighriskSpecialPrefixListResponse.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
+                        @highrisk_special_prefix_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Voice::V1PageMetadata>';
+                    end
+                end
+                class HighriskSpecialPrefixListResponse < InstanceListResource
+
+                    # @param [Array<HighriskSpecialPrefixInstance>] 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
+                      @highrisk_special_prefix = data_list.map do |data|
+                        HighriskSpecialPrefixInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def highrisk_special_prefix
+                        @highrisk_special_prefix
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class HighriskSpecialPrefixInstance < InstanceResource
                     ##
                     # Initialize the HighriskSpecialPrefixInstance
@@ -166,6 +262,7 @@ module Twilio
                     def initialize(version, payload , iso_code: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'prefix' => payload['prefix'],

data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb

@@ -20,12 +20,14 @@ module Twilio
                 class DialingPermissionsList < ListResource
 
                      class CountryList < ListResource
+                
                     ##
                     # Initialize the CountryList
                     # @param [Version] version Version that contains the resource
                     # @return [CountryList] CountryList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/DialingPermissions/Countries"
@@ -91,7 +93,45 @@ module Twilio
                             high_risk_tollfraud_numbers_enabled: high_risk_tollfraud_numbers_enabled,
                             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 CountryPageMetadata records from the API as a list.
+                      # @param [String] iso_code Filter to retrieve the country permissions by specifying the [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+                      # @param [String] continent Filter to retrieve the country permissions by specifying the continent
+                      # @param [String] country_code Filter the results by specified [country codes](https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html)
+                      # @param [Boolean] low_risk_numbers_enabled Filter to retrieve the country permissions with dialing to low-risk numbers enabled. Can be: `true` or `false`.
+                      # @param [Boolean] high_risk_special_numbers_enabled Filter to retrieve the country permissions with dialing to high-risk special service numbers enabled. Can be: `true` or `false`
+                      # @param [Boolean] high_risk_tollfraud_numbers_enabled Filter to retrieve the country permissions with dialing to high-risk [toll fraud](https://www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html) numbers enabled. Can be: `true` or `false`.
+                    # @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(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_numbers_enabled: :unset, high_risk_special_numbers_enabled: :unset, high_risk_tollfraud_numbers_enabled: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'IsoCode' => iso_code,
+                            'Continent' => continent,
+                            'CountryCode' => country_code,
+                            'LowRiskNumbersEnabled' => low_risk_numbers_enabled,
+                            'HighRiskSpecialNumbersEnabled' => high_risk_special_numbers_enabled,
+                            'HighRiskTollfraudNumbersEnabled' => high_risk_tollfraud_numbers_enabled,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        CountryPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -103,9 +143,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
 
                     ##
@@ -121,7 +165,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 CountryInstance
-                    def page(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_numbers_enabled: :unset, high_risk_special_numbers_enabled: :unset, high_risk_tollfraud_numbers_enabled: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_numbers_enabled: :unset, high_risk_special_numbers_enabled: :unset, high_risk_tollfraud_numbers_enabled: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'IsoCode' => iso_code,
                             'Continent' => continent,
@@ -133,8 +177,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)
 
                         CountryPage.new(@version, response, @solution)
                     end
@@ -161,8 +208,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
                 class CountryContext < InstanceContext
                     ##
                     # Initialize the CountryContext
@@ -171,6 +216,7 @@ module Twilio
                     # @return [CountryContext] CountryContext
                     def initialize(version, iso_code)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { iso_code: iso_code,  }
@@ -184,7 +230,13 @@ module Twilio
                     # @return [CountryInstance] Fetched CountryInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         CountryInstance.new(
                             @version,
                             payload,
@@ -192,6 +244,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the CountryInstanceMetadata
+                    # @return [CountryInstance] Fetched CountryInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        country_instance = CountryInstance.new(
+                            @version,
+                            response.body,
+                            iso_code: @solution[:iso_code],
+                        )
+                        CountryInstanceMetadata.new(
+                            @version,
+                            country_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the highrisk_special_prefixes
                     # @return [HighriskSpecialPrefixList]
@@ -219,6 +296,53 @@ module Twilio
                     end
                 end
 
+                class CountryInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new CountryInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}CountryInstance] country_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 [CountryInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, country_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @country_instance = country_instance
+                    end
+
+                    def country
+                        @country_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.CountryInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class CountryListResponse < InstanceListResource
+                    # @param [Array<CountryInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @country_instance = payload.body[key].map do |data|
+                        CountryInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def country_instance
+                          @instance
+                      end
+                  end
+
                 class CountryPage < Page
                     ##
                     # Initialize the CountryPage
@@ -228,6 +352,7 @@ module Twilio
                     # @return [CountryPage] CountryPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -247,6 +372,66 @@ module Twilio
                         '<Twilio.Voice.V1.CountryPage>'
                     end
                 end
+
+                class CountryPageMetadata < PageMetadata
+                    attr_reader :country_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @country_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @country_page << CountryListResponse.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
+                        @country_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Voice::V1PageMetadata>';
+                    end
+                end
+                class CountryListResponse < InstanceListResource
+
+                    # @param [Array<CountryInstance>] 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
+                      @country = data_list.map do |data|
+                        CountryInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def country
+                        @country
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class CountryInstance < InstanceResource
                     ##
                     # Initialize the CountryInstance
@@ -260,6 +445,7 @@ module Twilio
                     def initialize(version, payload , iso_code: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'iso_code' => payload['iso_code'],