twilio-ruby 7.3.3 → 7.10.1

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

@@ -27,6 +27,7 @@ module Twilio
                     # @return [RegulationList] RegulationList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/RegulatoryCompliance/Regulations"
@@ -87,6 +88,36 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     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
+
                     ##
                     # When passed a block, yields RegulationInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -112,7 +143,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 RegulationInstance
-                    def page(end_user_type: :unset, iso_country: :unset, number_type: :unset, include_constraints: :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,
@@ -122,8 +153,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)
 
                         RegulationPage.new(@version, response, @solution)
                     end
@@ -158,6 +192,7 @@ module Twilio
                     # @return [RegulationContext] RegulationContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -178,6 +213,10 @@ module Twilio
                         })
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, params: params, headers: headers)
                         RegulationInstance.new(
                             @version,
@@ -186,6 +225,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
@@ -202,6 +272,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
@@ -211,6 +328,7 @@ module Twilio
                     # @return [RegulationPage] RegulationPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -230,6 +348,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
@@ -243,6 +421,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/supporting_document.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [SupportingDocumentList] SupportingDocumentList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/RegulatoryCompliance/SupportingDocuments"
@@ -52,6 +53,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.create('POST', @uri, data: data, headers: headers)
                         SupportingDocumentInstance.new(
                             @version,
@@ -59,6 +64,43 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the SupportingDocumentInstanceMetadata
+                    # @param [String] friendly_name The string that you assigned to describe the resource.
+                    # @param [String] type The type of the Supporting Document.
+                    # @param [Object] attributes The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types.
+                    # @return [SupportingDocumentInstance] Created SupportingDocumentInstance
+                    def create_with_metadata(
+                      friendly_name: nil, 
+                      type: nil, 
+                      attributes: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Type' => type,
+                            'Attributes' => Twilio.serialize_object(attributes),
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        supporting_document_instance = SupportingDocumentInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        SupportingDocumentInstanceMetadata.new(
+                            @version,
+                            supporting_document_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists SupportingDocumentInstance records from the API as a list.
@@ -98,6 +140,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists SupportingDocumentPageMetadata 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)
+
+                        SupportingDocumentPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields SupportingDocumentInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -119,14 +183,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 SupportingDocumentInstance
-                    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)
 
                         SupportingDocumentPage.new(@version, response, @solution)
                     end
@@ -161,6 +228,7 @@ module Twilio
                     # @return [SupportingDocumentContext] SupportingDocumentContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -175,9 +243,31 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the SupportingDocumentInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          supportingDocument_instance = SupportingDocumentInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          SupportingDocumentInstanceMetadata.new(@version, supportingDocument_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the SupportingDocumentInstance
                     # @return [SupportingDocumentInstance] Fetched SupportingDocumentInstance
@@ -185,6 +275,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         SupportingDocumentInstance.new(
                             @version,
@@ -193,6 +287,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the SupportingDocumentInstanceMetadata
+                    # @return [SupportingDocumentInstance] Fetched SupportingDocumentInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        supporting_document_instance = SupportingDocumentInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        SupportingDocumentInstanceMetadata.new(
+                            @version,
+                            supporting_document_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the SupportingDocumentInstance
                     # @param [String] friendly_name The string that you assigned to describe the resource.
@@ -210,6 +329,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         SupportingDocumentInstance.new(
                             @version,
@@ -218,6 +341,41 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the SupportingDocumentInstanceMetadata
+                    # @param [String] friendly_name The string that you assigned to describe the resource.
+                    # @param [Object] attributes The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.
+                    # @return [SupportingDocumentInstance] Updated SupportingDocumentInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      attributes: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Attributes' => Twilio.serialize_object(attributes),
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        supporting_document_instance = SupportingDocumentInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        SupportingDocumentInstanceMetadata.new(
+                            @version,
+                            supporting_document_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -234,6 +392,53 @@ module Twilio
                     end
                 end
 
+                class SupportingDocumentInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new SupportingDocumentInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}SupportingDocumentInstance] supporting_document_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 [SupportingDocumentInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, supporting_document_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @supporting_document_instance = supporting_document_instance
+                    end
+
+                    def supporting_document
+                        @supporting_document_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.SupportingDocumentInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class SupportingDocumentListResponse < InstanceListResource
+                    # @param [Array<SupportingDocumentInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @supporting_document_instance = payload.body[key].map do |data|
+                        SupportingDocumentInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def supporting_document_instance
+                          @instance
+                      end
+                  end
+
                 class SupportingDocumentPage < Page
                     ##
                     # Initialize the SupportingDocumentPage
@@ -243,6 +448,7 @@ module Twilio
                     # @return [SupportingDocumentPage] SupportingDocumentPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -262,6 +468,66 @@ module Twilio
                         '<Twilio.Numbers.V2.SupportingDocumentPage>'
                     end
                 end
+
+                class SupportingDocumentPageMetadata < PageMetadata
+                    attr_reader :supporting_document_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @supporting_document_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @supporting_document_page << SupportingDocumentListResponse.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
+                        @supporting_document_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V2PageMetadata>';
+                    end
+                end
+                class SupportingDocumentListResponse < InstanceListResource
+
+                    # @param [Array<SupportingDocumentInstance>] 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
+                      @supporting_document = data_list.map do |data|
+                        SupportingDocumentInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def supporting_document
+                        @supporting_document
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class SupportingDocumentInstance < InstanceResource
                     ##
                     # Initialize the SupportingDocumentInstance
@@ -275,6 +541,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],