twilio-ruby 7.3.3 → 7.10.1

data/lib/twilio-ruby/rest/lookups/v2/phone_number.rb

@@ -25,6 +25,7 @@ module Twilio
                     # @return [PhoneNumberList] PhoneNumberList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         
@@ -48,6 +49,7 @@ module Twilio
                     # @return [PhoneNumberContext] PhoneNumberContext
                     def initialize(version, phone_number)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { phone_number: phone_number,  }
@@ -71,6 +73,7 @@ module Twilio
                     # @param [String] date_of_birth User’s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests.
                     # @param [String] last_verified_date The date you obtained consent to call or text the end-user of the phone number or a date on which you are reasonably certain that the end-user could still be reached at that number. This query parameter is only used (optionally) for reassigned_number package requests.
                     # @param [String] verification_sid The unique identifier associated with a verification process through verify API. This query parameter is only used (optionally) for pre_fill package requests.
+                    # @param [String] partner_sub_id The optional partnerSubId parameter to provide context for your sub-accounts, tenantIDs, sender IDs or other segmentation, enhancing the accuracy of the risk analysis.
                     # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
                     def fetch(
                         fields: :unset, 
@@ -86,7 +89,8 @@ module Twilio
                         national_id: :unset, 
                         date_of_birth: :unset, 
                         last_verified_date: :unset, 
-                        verification_sid: :unset
+                        verification_sid: :unset, 
+                        partner_sub_id: :unset
                     )
 
                         params = Twilio::Values.of({
@@ -104,9 +108,14 @@ module Twilio
                             'DateOfBirth' => date_of_birth,
                             'LastVerifiedDate' => last_verified_date,
                             'VerificationSid' => verification_sid,
+                            'PartnerSubId' => partner_sub_id,
                         })
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, params: params, headers: headers)
                         PhoneNumberInstance.new(
                             @version,
@@ -115,6 +124,79 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the PhoneNumberInstanceMetadata
+                    # @param [String] fields A comma-separated list of fields to return. Possible values are validation, caller_name, sim_swap, call_forwarding, line_status, line_type_intelligence, identity_match, reassigned_number, sms_pumping_risk, phone_number_quality_score, pre_fill.
+                    # @param [String] country_code The [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) used if the phone number provided is in national format.
+                    # @param [String] first_name User’s first name. This query parameter is only used (optionally) for identity_match package requests.
+                    # @param [String] last_name User’s last name. This query parameter is only used (optionally) for identity_match package requests.
+                    # @param [String] address_line1 User’s first address line. This query parameter is only used (optionally) for identity_match package requests.
+                    # @param [String] address_line2 User’s second address line. This query parameter is only used (optionally) for identity_match package requests.
+                    # @param [String] city User’s city. This query parameter is only used (optionally) for identity_match package requests.
+                    # @param [String] state User’s country subdivision, such as state, province, or locality. This query parameter is only used (optionally) for identity_match package requests.
+                    # @param [String] postal_code User’s postal zip code. This query parameter is only used (optionally) for identity_match package requests.
+                    # @param [String] address_country_code User’s country, up to two characters. This query parameter is only used (optionally) for identity_match package requests.
+                    # @param [String] national_id User’s national ID, such as SSN or Passport ID. This query parameter is only used (optionally) for identity_match package requests.
+                    # @param [String] date_of_birth User’s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests.
+                    # @param [String] last_verified_date The date you obtained consent to call or text the end-user of the phone number or a date on which you are reasonably certain that the end-user could still be reached at that number. This query parameter is only used (optionally) for reassigned_number package requests.
+                    # @param [String] verification_sid The unique identifier associated with a verification process through verify API. This query parameter is only used (optionally) for pre_fill package requests.
+                    # @param [String] partner_sub_id The optional partnerSubId parameter to provide context for your sub-accounts, tenantIDs, sender IDs or other segmentation, enhancing the accuracy of the risk analysis.
+                    # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
+                    def fetch_with_metadata(
+                      fields: :unset, 
+                      country_code: :unset, 
+                      first_name: :unset, 
+                      last_name: :unset, 
+                      address_line1: :unset, 
+                      address_line2: :unset, 
+                      city: :unset, 
+                      state: :unset, 
+                      postal_code: :unset, 
+                      address_country_code: :unset, 
+                      national_id: :unset, 
+                      date_of_birth: :unset, 
+                      last_verified_date: :unset, 
+                      verification_sid: :unset, 
+                      partner_sub_id: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'Fields' => fields,
+                            'CountryCode' => country_code,
+                            'FirstName' => first_name,
+                            'LastName' => last_name,
+                            'AddressLine1' => address_line1,
+                            'AddressLine2' => address_line2,
+                            'City' => city,
+                            'State' => state,
+                            'PostalCode' => postal_code,
+                            'AddressCountryCode' => address_country_code,
+                            'NationalId' => national_id,
+                            'DateOfBirth' => date_of_birth,
+                            'LastVerifiedDate' => last_verified_date,
+                            'VerificationSid' => verification_sid,
+                            'PartnerSubId' => partner_sub_id,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        phone_number_instance = PhoneNumberInstance.new(
+                            @version,
+                            response.body,
+                            phone_number: @solution[:phone_number],
+                        )
+                        PhoneNumberInstanceMetadata.new(
+                            @version,
+                            phone_number_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -131,6 +213,53 @@ module Twilio
                     end
                 end
 
+                class PhoneNumberInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new PhoneNumberInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}PhoneNumberInstance] phone_number_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 [PhoneNumberInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, phone_number_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @phone_number_instance = phone_number_instance
+                    end
+
+                    def phone_number
+                        @phone_number_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.PhoneNumberInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class PhoneNumberListResponse < InstanceListResource
+                    # @param [Array<PhoneNumberInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @phone_number_instance = payload.body[key].map do |data|
+                        PhoneNumberInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def phone_number_instance
+                          @instance
+                      end
+                  end
+
                 class PhoneNumberPage < Page
                     ##
                     # Initialize the PhoneNumberPage
@@ -140,6 +269,7 @@ module Twilio
                     # @return [PhoneNumberPage] PhoneNumberPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -159,6 +289,66 @@ module Twilio
                         '<Twilio.Lookups.V2.PhoneNumberPage>'
                     end
                 end
+
+                class PhoneNumberPageMetadata < PageMetadata
+                    attr_reader :phone_number_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @phone_number_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @phone_number_page << PhoneNumberListResponse.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
+                        @phone_number_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Lookups::V2PageMetadata>';
+                    end
+                end
+                class PhoneNumberListResponse < InstanceListResource
+
+                    # @param [Array<PhoneNumberInstance>] 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
+                      @phone_number = data_list.map do |data|
+                        PhoneNumberInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def phone_number
+                        @phone_number
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class PhoneNumberInstance < InstanceResource
                     ##
                     # Initialize the PhoneNumberInstance
@@ -172,6 +362,7 @@ module Twilio
                     def initialize(version, payload , phone_number: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'calling_country_code' => payload['calling_country_code'],
@@ -183,8 +374,8 @@ module Twilio
                             'caller_name' => payload['caller_name'],
                             'sim_swap' => payload['sim_swap'],
                             'call_forwarding' => payload['call_forwarding'],
-                            'line_status' => payload['line_status'],
                             'line_type_intelligence' => payload['line_type_intelligence'],
+                            'line_status' => payload['line_status'],
                             'identity_match' => payload['identity_match'],
                             'reassigned_number' => payload['reassigned_number'],
                             'sms_pumping_risk' => payload['sms_pumping_risk'],
@@ -246,49 +437,49 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Hash] An object that contains caller name information based on [CNAM](https://support.twilio.com/hc/en-us/articles/360051670533-Getting-Started-with-CNAM-Caller-ID).
+                    # @return [CallerNameInfo] 
                     def caller_name
                         @properties['caller_name']
                     end
                     
                     ##
-                    # @return [Hash] An object that contains information on the last date the subscriber identity module (SIM) was changed for a mobile phone number.
+                    # @return [SimSwapInfo] 
                     def sim_swap
                         @properties['sim_swap']
                     end
                     
                     ##
-                    # @return [Hash] An object that contains information on the unconditional call forwarding status of mobile phone number.
+                    # @return [CallForwardingInfo] 
                     def call_forwarding
                         @properties['call_forwarding']
                     end
                     
                     ##
-                    # @return [Hash] An object that contains line status information for a mobile phone number.
-                    def line_status
-                        @properties['line_status']
+                    # @return [LineTypeIntelligenceInfo] 
+                    def line_type_intelligence
+                        @properties['line_type_intelligence']
                     end
                     
                     ##
-                    # @return [Hash] An object that contains line type information including the carrier name, mobile country code, and mobile network code.
-                    def line_type_intelligence
-                        @properties['line_type_intelligence']
+                    # @return [LineStatusInfo] 
+                    def line_status
+                        @properties['line_status']
                     end
                     
                     ##
-                    # @return [Hash] An object that contains identity match information. The result of comparing user-provided information including name, address, date of birth, national ID, against authoritative phone-based data sources
+                    # @return [IdentityMatchInfo] 
                     def identity_match
                         @properties['identity_match']
                     end
                     
                     ##
-                    # @return [Hash] An object that contains reassigned number information. Reassigned Numbers will return a phone number's reassignment status given a phone number and date
+                    # @return [ReassignedNumberInfo] 
                     def reassigned_number
                         @properties['reassigned_number']
                     end
                     
                     ##
-                    # @return [Hash] An object that contains information on if a phone number has been currently or previously blocked by Verify Fraud Guard for receiving malicious SMS pumping traffic as well as other signals associated with risky carriers and low conversion rates.
+                    # @return [SmsPumpingRiskInfo] 
                     def sms_pumping_risk
                         @properties['sms_pumping_risk']
                     end
@@ -327,6 +518,7 @@ module Twilio
                     # @param [String] date_of_birth User’s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests.
                     # @param [String] last_verified_date The date you obtained consent to call or text the end-user of the phone number or a date on which you are reasonably certain that the end-user could still be reached at that number. This query parameter is only used (optionally) for reassigned_number package requests.
                     # @param [String] verification_sid The unique identifier associated with a verification process through verify API. This query parameter is only used (optionally) for pre_fill package requests.
+                    # @param [String] partner_sub_id The optional partnerSubId parameter to provide context for your sub-accounts, tenantIDs, sender IDs or other segmentation, enhancing the accuracy of the risk analysis.
                     # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
                     def fetch(
                         fields: :unset, 
@@ -342,7 +534,8 @@ module Twilio
                         national_id: :unset, 
                         date_of_birth: :unset, 
                         last_verified_date: :unset, 
-                        verification_sid: :unset
+                        verification_sid: :unset, 
+                        partner_sub_id: :unset
                     )
 
                         context.fetch(
@@ -360,6 +553,7 @@ module Twilio
                             date_of_birth: date_of_birth, 
                             last_verified_date: last_verified_date, 
                             verification_sid: verification_sid, 
+                            partner_sub_id: partner_sub_id, 
                         )
                     end