twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user_type.rb

@@ -20,12 +20,14 @@ module Twilio
                 class RegulatoryComplianceList < ListResource
 
                      class EndUserTypeList < ListResource
+                
                     ##
                     # Initialize the EndUserTypeList
                     # @param [Version] version Version that contains the resource
                     # @return [EndUserTypeList] EndUserTypeList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/RegulatoryCompliance/EndUserTypes"
@@ -67,7 +69,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 EndUserTypePageMetadata 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)
+
+                        EndUserTypePageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -79,9 +107,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
 
                     ##
@@ -91,14 +123,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 EndUserTypeInstance
-                    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)
 
                         EndUserTypePage.new(@version, response, @solution)
                     end
@@ -133,6 +168,7 @@ module Twilio
                     # @return [EndUserTypeContext] EndUserTypeContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -145,7 +181,13 @@ module Twilio
                     # @return [EndUserTypeInstance] Fetched EndUserTypeInstance
                     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)
                         EndUserTypeInstance.new(
                             @version,
                             payload,
@@ -153,6 +195,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the EndUserTypeInstanceMetadata
+                    # @return [EndUserTypeInstance] Fetched EndUserTypeInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        end_user_type_instance = EndUserTypeInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        EndUserTypeInstanceMetadata.new(
+                            @version,
+                            end_user_type_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -169,6 +236,53 @@ module Twilio
                     end
                 end
 
+                class EndUserTypeInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new EndUserTypeInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}EndUserTypeInstance] end_user_type_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 [EndUserTypeInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, end_user_type_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @end_user_type_instance = end_user_type_instance
+                    end
+
+                    def end_user_type
+                        @end_user_type_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.EndUserTypeInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class EndUserTypeListResponse < InstanceListResource
+                    # @param [Array<EndUserTypeInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @end_user_type_instance = payload.body[key].map do |data|
+                        EndUserTypeInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def end_user_type_instance
+                          @instance
+                      end
+                  end
+
                 class EndUserTypePage < Page
                     ##
                     # Initialize the EndUserTypePage
@@ -178,6 +292,7 @@ module Twilio
                     # @return [EndUserTypePage] EndUserTypePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -197,6 +312,66 @@ module Twilio
                         '<Twilio.Numbers.V2.EndUserTypePage>'
                     end
                 end
+
+                class EndUserTypePageMetadata < PageMetadata
+                    attr_reader :end_user_type_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @end_user_type_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @end_user_type_page << EndUserTypeListResponse.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
+                        @end_user_type_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V2PageMetadata>';
+                    end
+                end
+                class EndUserTypeListResponse < InstanceListResource
+
+                    # @param [Array<EndUserTypeInstance>] 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
+                      @end_user_type = data_list.map do |data|
+                        EndUserTypeInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def end_user_type
+                        @end_user_type
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class EndUserTypeInstance < InstanceResource
                     ##
                     # Initialize the EndUserTypeInstance
@@ -210,6 +385,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb

@@ -20,12 +20,14 @@ module Twilio
                 class RegulatoryComplianceList < ListResource
 
                      class RegulationList < ListResource
+                
                     ##
                     # Initialize the RegulationList
                     # @param [Version] version Version that contains the resource
                     # @return [RegulationList] RegulationList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/RegulatoryCompliance/Regulations"
@@ -39,6 +41,7 @@ module Twilio
                     # @param [EndUserType] end_user_type The type of End User the regulation requires - can be `individual` or `business`.
                     # @param [String] iso_country The ISO country code of the phone number's country.
                     # @param [String] number_type The type of phone number that the regulatory requiremnt is restricting.
+                    # @param [Boolean] include_constraints A boolean parameter indicating whether to include constraints or not for supporting end user, documents and their fields
                     # @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
@@ -46,11 +49,12 @@ module Twilio
                     #    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(end_user_type: :unset, iso_country: :unset, number_type: :unset, limit: nil, page_size: nil)
+                    def list(end_user_type: :unset, iso_country: :unset, number_type: :unset, include_constraints: :unset, limit: nil, page_size: nil)
                         self.stream(
                             end_user_type: end_user_type,
                             iso_country: iso_country,
                             number_type: number_type,
+                            include_constraints: include_constraints,
                             limit: limit,
                             page_size: page_size
                         ).entries
@@ -63,6 +67,7 @@ module Twilio
                     # @param [EndUserType] end_user_type The type of End User the regulation requires - can be `individual` or `business`.
                     # @param [String] iso_country The ISO country code of the phone number's country.
                     # @param [String] number_type The type of phone number that the regulatory requiremnt is restricting.
+                    # @param [Boolean] include_constraints A boolean parameter indicating whether to include constraints or not for supporting end user, documents and their fields
                     # @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
@@ -70,16 +75,51 @@ module Twilio
                     #    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(end_user_type: :unset, iso_country: :unset, number_type: :unset, limit: nil, page_size: nil)
+                    def stream(end_user_type: :unset, iso_country: :unset, number_type: :unset, include_constraints: :unset, limit: nil, page_size: nil)
                         limits = @version.read_limits(limit, page_size)
 
                         page = self.page(
                             end_user_type: end_user_type,
                             iso_country: iso_country,
                             number_type: number_type,
+                            include_constraints: include_constraints,
                             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 RegulationPageMetadata records from the API as a list.
+                      # @param [EndUserType] end_user_type The type of End User the regulation requires - can be `individual` or `business`.
+                      # @param [String] iso_country The ISO country code of the phone number's country.
+                      # @param [String] number_type The type of phone number that the regulatory requiremnt is restricting.
+                      # @param [Boolean] include_constraints A boolean parameter indicating whether to include constraints or not for supporting end user, documents and their fields
+                    # @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(end_user_type: :unset, iso_country: :unset, number_type: :unset, include_constraints: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'EndUserType' => end_user_type,
+                            'IsoCountry' => iso_country,
+                            'NumberType' => number_type,
+                            'IncludeConstraints' => include_constraints,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        RegulationPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -91,9 +131,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
 
                     ##
@@ -102,21 +146,26 @@ module Twilio
                     # @param [EndUserType] end_user_type The type of End User the regulation requires - can be `individual` or `business`.
                     # @param [String] iso_country The ISO country code of the phone number's country.
                     # @param [String] number_type The type of phone number that the regulatory requiremnt is restricting.
+                    # @param [Boolean] include_constraints A boolean parameter indicating whether to include constraints or not for supporting end user, documents and their fields
                     # @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 RegulationInstance
-                    def page(end_user_type: :unset, iso_country: :unset, number_type: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(end_user_type: :unset, iso_country: :unset, number_type: :unset, include_constraints: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'EndUserType' => end_user_type,
                             'IsoCountry' => iso_country,
                             'NumberType' => number_type,
+                            'IncludeConstraints' => include_constraints,
                             '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)
 
                         RegulationPage.new(@version, response, @solution)
                     end
@@ -151,6 +200,7 @@ module Twilio
                     # @return [RegulationContext] RegulationContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -160,10 +210,22 @@ module Twilio
                     end
                     ##
                     # Fetch the RegulationInstance
+                    # @param [Boolean] include_constraints A boolean parameter indicating whether to include constraints or not for supporting end user, documents and their fields
                     # @return [RegulationInstance] Fetched RegulationInstance
-                    def fetch
+                    def fetch(
+                      include_constraints: :unset
+                    )
 
-                        payload = @version.fetch('GET', @uri)
+                        params = Twilio::Values.of({
+                            'IncludeConstraints' => include_constraints,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
                         RegulationInstance.new(
                             @version,
                             payload,
@@ -171,6 +233,37 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the RegulationInstanceMetadata
+                    # @param [Boolean] include_constraints A boolean parameter indicating whether to include constraints or not for supporting end user, documents and their fields
+                    # @return [RegulationInstance] Fetched RegulationInstance
+                    def fetch_with_metadata(
+                      include_constraints: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'IncludeConstraints' => include_constraints,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        regulation_instance = RegulationInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        RegulationInstanceMetadata.new(
+                            @version,
+                            regulation_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -187,6 +280,53 @@ module Twilio
                     end
                 end
 
+                class RegulationInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new RegulationInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}RegulationInstance] regulation_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 [RegulationInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, regulation_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @regulation_instance = regulation_instance
+                    end
+
+                    def regulation
+                        @regulation_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.RegulationInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class RegulationListResponse < InstanceListResource
+                    # @param [Array<RegulationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @regulation_instance = payload.body[key].map do |data|
+                        RegulationInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def regulation_instance
+                          @instance
+                      end
+                  end
+
                 class RegulationPage < Page
                     ##
                     # Initialize the RegulationPage
@@ -196,6 +336,7 @@ module Twilio
                     # @return [RegulationPage] RegulationPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -215,6 +356,66 @@ module Twilio
                         '<Twilio.Numbers.V2.RegulationPage>'
                     end
                 end
+
+                class RegulationPageMetadata < PageMetadata
+                    attr_reader :regulation_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @regulation_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @regulation_page << RegulationListResponse.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
+                        @regulation_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V2PageMetadata>';
+                    end
+                end
+                class RegulationListResponse < InstanceListResource
+
+                    # @param [Array<RegulationInstance>] 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
+                      @regulation = data_list.map do |data|
+                        RegulationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def regulation
+                        @regulation
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class RegulationInstance < InstanceResource
                     ##
                     # Initialize the RegulationInstance
@@ -228,6 +429,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -299,10 +501,15 @@ module Twilio
                     
                     ##
                     # Fetch the RegulationInstance
+                    # @param [Boolean] include_constraints A boolean parameter indicating whether to include constraints or not for supporting end user, documents and their fields
                     # @return [RegulationInstance] Fetched RegulationInstance
-                    def fetch
+                    def fetch(
+                      include_constraints: :unset
+                    )
 
-                        context.fetch
+                        context.fetch(
+                            include_constraints: include_constraints, 
+                        )
                     end
 
                     ##