twilio-ruby 5.40.3 → 5.74.1

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

@@ -63,7 +63,7 @@ module Twilio
           # Initialize the PhoneNumberContext
           # @param [Version] version Version that contains the resource
           # @param [String] phone_number The phone number to lookup in
-          #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists
+          #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, which consists
           #   of a + followed by the country code and subscriber number.
           # @return [PhoneNumberContext] PhoneNumberContext
           def initialize(version, phone_number)
@@ -76,21 +76,21 @@ module Twilio
 
           ##
           # Fetch the PhoneNumberInstance
-          # @param [String] country_code The [ISO country
-          #   code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number to
+          # @param [String] country_code The {ISO country
+          #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the phone number to
           #   fetch. This is used to specify the country when the phone number is provided in
           #   a national format.
-          # @param [String] type The type of information to return. Can be: `carrier` or
-          #   `caller-name`. The default is null.  Carrier information costs $0.005 per phone
-          #   number looked up.  Caller Name information is currently available only in the US
-          #   and costs $0.01 per phone number looked up.  To retrieve both types on
+          # @param [Array[String]] type The type of information to return. Can be: `carrier`
+          #   or `caller-name`. The default is null.  Carrier information costs $0.005 per
+          #   phone number looked up.  Caller Name information is currently available only in
+          #   the US and costs $0.01 per phone number looked up.  To retrieve both types on
           #   information, specify this parameter twice; once with `carrier` and once with
           #   `caller-name` as the value.
-          # @param [String] add_ons The `unique_name` of an Add-on you would like to invoke.
-          #   Can be the `unique_name` of an Add-on that is installed on your account. You can
-          #   specify multiple instances of this parameter to invoke multiple Add-ons. For
-          #   more information about  Add-ons, see the [Add-ons
-          #   documentation](https://www.twilio.com/docs/add-ons).
+          # @param [Array[String]] add_ons The `unique_name` of an Add-on you would like to
+          #   invoke. Can be the `unique_name` of an Add-on that is installed on your account.
+          #   You can specify multiple instances of this parameter to invoke multiple Add-ons.
+          #   For more information about  Add-ons, see the {Add-ons
+          #   documentation}[https://www.twilio.com/docs/add-ons].
           # @param [Hash] add_ons_data Data specific to the add-on you would like to invoke.
           #   The content and format of this value depends on the add-on.
           # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
@@ -128,7 +128,7 @@ module Twilio
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
           # @param [String] phone_number The phone number to lookup in
-          #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists
+          #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, which consists
           #   of a + followed by the country code and subscriber number.
           # @return [PhoneNumberInstance] PhoneNumberInstance
           def initialize(version, payload, phone_number: nil)
@@ -205,21 +205,21 @@ module Twilio
 
           ##
           # Fetch the PhoneNumberInstance
-          # @param [String] country_code The [ISO country
-          #   code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number to
+          # @param [String] country_code The {ISO country
+          #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the phone number to
           #   fetch. This is used to specify the country when the phone number is provided in
           #   a national format.
-          # @param [String] type The type of information to return. Can be: `carrier` or
-          #   `caller-name`. The default is null.  Carrier information costs $0.005 per phone
-          #   number looked up.  Caller Name information is currently available only in the US
-          #   and costs $0.01 per phone number looked up.  To retrieve both types on
+          # @param [Array[String]] type The type of information to return. Can be: `carrier`
+          #   or `caller-name`. The default is null.  Carrier information costs $0.005 per
+          #   phone number looked up.  Caller Name information is currently available only in
+          #   the US and costs $0.01 per phone number looked up.  To retrieve both types on
           #   information, specify this parameter twice; once with `carrier` and once with
           #   `caller-name` as the value.
-          # @param [String] add_ons The `unique_name` of an Add-on you would like to invoke.
-          #   Can be the `unique_name` of an Add-on that is installed on your account. You can
-          #   specify multiple instances of this parameter to invoke multiple Add-ons. For
-          #   more information about  Add-ons, see the [Add-ons
-          #   documentation](https://www.twilio.com/docs/add-ons).
+          # @param [Array[String]] add_ons The `unique_name` of an Add-on you would like to
+          #   invoke. Can be the `unique_name` of an Add-on that is installed on your account.
+          #   You can specify multiple instances of this parameter to invoke multiple Add-ons.
+          #   For more information about  Add-ons, see the {Add-ons
+          #   documentation}[https://www.twilio.com/docs/add-ons].
           # @param [Hash] add_ons_data Data specific to the add-on you would like to invoke.
           #   The content and format of this value depends on the add-on.
           # @return [PhoneNumberInstance] Fetched PhoneNumberInstance

data/lib/twilio-ruby/rest/lookups/v1.rb

@@ -20,17 +20,18 @@ module Twilio
 
         ##
         # @param [String] phone_number The phone number to lookup in
-        #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists
+        #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, which consists
         #   of a + followed by the country code and subscriber number.
         # @return [Twilio::REST::Lookups::V1::PhoneNumberContext] if phone_number was passed.
         # @return [Twilio::REST::Lookups::V1::PhoneNumberList]
         def phone_numbers(phone_number=:unset)
           if phone_number.nil?
-            raise ArgumentError, 'phone_number cannot be nil'
-          elsif phone_number == :unset
-            @phone_numbers ||= PhoneNumberList.new self
+              raise ArgumentError, 'phone_number cannot be nil'
+          end
+          if phone_number == :unset
+              @phone_numbers ||= PhoneNumberList.new self
           else
-            PhoneNumberContext.new(self, phone_number)
+              PhoneNumberContext.new(self, phone_number)
           end
         end
 

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

@@ -0,0 +1,336 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Lookups < Domain
+      class V2 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class PhoneNumberList < ListResource
+          ##
+          # Initialize the PhoneNumberList
+          # @param [Version] version Version that contains the resource
+          # @return [PhoneNumberList] PhoneNumberList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Lookups.V2.PhoneNumberList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class PhoneNumberPage < Page
+          ##
+          # Initialize the PhoneNumberPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [PhoneNumberPage] PhoneNumberPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of PhoneNumberInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [PhoneNumberInstance] PhoneNumberInstance
+          def get_instance(payload)
+            PhoneNumberInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Lookups.V2.PhoneNumberPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class PhoneNumberContext < InstanceContext
+          ##
+          # Initialize the PhoneNumberContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] phone_number The phone number to lookup in E.164 or national
+          #   format. Default country code is +1 (North America).
+          # @return [PhoneNumberContext] PhoneNumberContext
+          def initialize(version, phone_number)
+            super(version)
+
+            # Path Solution
+            @solution = {phone_number: phone_number, }
+            @uri = "/PhoneNumbers/#{@solution[:phone_number]}"
+          end
+
+          ##
+          # Fetch the PhoneNumberInstance
+          # @param [String] fields A comma-separated list of fields to return. Possible
+          #   values are caller_name, sim_swap, call_forwarding, live_activity,
+          #   line_type_intelligence, identity_match.
+          # @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_line_1 User’s first address line. This query parameter
+          #   is only used (optionally) for identity_match package requests.
+          # @param [String] address_line_2 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.
+          # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
+          def fetch(fields: :unset, country_code: :unset, first_name: :unset, last_name: :unset, address_line_1: :unset, address_line_2: :unset, city: :unset, state: :unset, postal_code: :unset, address_country_code: :unset, national_id: :unset, date_of_birth: :unset)
+            params = Twilio::Values.of({
+                'Fields' => fields,
+                'CountryCode' => country_code,
+                'FirstName' => first_name,
+                'LastName' => last_name,
+                'AddressLine1' => address_line_1,
+                'AddressLine2' => address_line_2,
+                'City' => city,
+                'State' => state,
+                'PostalCode' => postal_code,
+                'AddressCountryCode' => address_country_code,
+                'NationalId' => national_id,
+                'DateOfBirth' => date_of_birth,
+            })
+
+            payload = @version.fetch('GET', @uri, params: params)
+
+            PhoneNumberInstance.new(@version, payload, phone_number: @solution[:phone_number], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Lookups.V2.PhoneNumberContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Lookups.V2.PhoneNumberContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class PhoneNumberInstance < InstanceResource
+          ##
+          # Initialize the PhoneNumberInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] phone_number The phone number to lookup in E.164 or national
+          #   format. Default country code is +1 (North America).
+          # @return [PhoneNumberInstance] PhoneNumberInstance
+          def initialize(version, payload, phone_number: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'calling_country_code' => payload['calling_country_code'],
+                'country_code' => payload['country_code'],
+                'phone_number' => payload['phone_number'],
+                'national_format' => payload['national_format'],
+                'valid' => payload['valid'],
+                'validation_errors' => payload['validation_errors'],
+                'caller_name' => payload['caller_name'],
+                'sim_swap' => payload['sim_swap'],
+                'call_forwarding' => payload['call_forwarding'],
+                'live_activity' => payload['live_activity'],
+                'line_type_intelligence' => payload['line_type_intelligence'],
+                'identity_match' => payload['identity_match'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'phone_number' => phone_number || @properties['phone_number'], }
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [PhoneNumberContext] PhoneNumberContext for this PhoneNumberInstance
+          def context
+            unless @instance_context
+              @instance_context = PhoneNumberContext.new(@version, @params['phone_number'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] International dialing prefix
+          def calling_country_code
+            @properties['calling_country_code']
+          end
+
+          ##
+          # @return [String] Phone number's ISO country code
+          def country_code
+            @properties['country_code']
+          end
+
+          ##
+          # @return [String] Phone number in E.164 format
+          def phone_number
+            @properties['phone_number']
+          end
+
+          ##
+          # @return [String] Phone number in national format
+          def national_format
+            @properties['national_format']
+          end
+
+          ##
+          # @return [Boolean] Boolean which indicates if the phone number is valid
+          def valid
+            @properties['valid']
+          end
+
+          ##
+          # @return [Array[phone_number.ValidationError]] Contains reasons why a phone number is invalid
+          def validation_errors
+            @properties['validation_errors']
+          end
+
+          ##
+          # @return [Hash] An object that contains caller name information
+          def caller_name
+            @properties['caller_name']
+          end
+
+          ##
+          # @return [Hash] An object that contains SIM swap information
+          def sim_swap
+            @properties['sim_swap']
+          end
+
+          ##
+          # @return [Hash] An object that contains call forwarding status information
+          def call_forwarding
+            @properties['call_forwarding']
+          end
+
+          ##
+          # @return [Hash] An object that contains live activity information
+          def live_activity
+            @properties['live_activity']
+          end
+
+          ##
+          # @return [Hash] An object that contains line type information
+          def line_type_intelligence
+            @properties['line_type_intelligence']
+          end
+
+          ##
+          # @return [Hash] An object that contains identity match information
+          def identity_match
+            @properties['identity_match']
+          end
+
+          ##
+          # @return [String] The absolute URL of the resource
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the PhoneNumberInstance
+          # @param [String] fields A comma-separated list of fields to return. Possible
+          #   values are caller_name, sim_swap, call_forwarding, live_activity,
+          #   line_type_intelligence, identity_match.
+          # @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_line_1 User’s first address line. This query parameter
+          #   is only used (optionally) for identity_match package requests.
+          # @param [String] address_line_2 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.
+          # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
+          def fetch(fields: :unset, country_code: :unset, first_name: :unset, last_name: :unset, address_line_1: :unset, address_line_2: :unset, city: :unset, state: :unset, postal_code: :unset, address_country_code: :unset, national_id: :unset, date_of_birth: :unset)
+            context.fetch(
+                fields: fields,
+                country_code: country_code,
+                first_name: first_name,
+                last_name: last_name,
+                address_line_1: address_line_1,
+                address_line_2: address_line_2,
+                city: city,
+                state: state,
+                postal_code: postal_code,
+                address_country_code: address_country_code,
+                national_id: national_id,
+                date_of_birth: date_of_birth,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Lookups.V2.PhoneNumberInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Lookups.V2.PhoneNumberInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Lookups
+      class V2 < Version
+        ##
+        # Initialize the V2 version of Lookups
+        def initialize(domain)
+          super
+          @version = 'v2'
+          @phone_numbers = nil
+        end
+
+        ##
+        # @param [String] phone_number The phone number to lookup in E.164 or national
+        #   format. Default country code is +1 (North America).
+        # @return [Twilio::REST::Lookups::V2::PhoneNumberContext] if phone_number was passed.
+        # @return [Twilio::REST::Lookups::V2::PhoneNumberList]
+        def phone_numbers(phone_number=:unset)
+          if phone_number.nil?
+              raise ArgumentError, 'phone_number cannot be nil'
+          end
+          if phone_number == :unset
+              @phone_numbers ||= PhoneNumberList.new self
+          else
+              PhoneNumberContext.new(self, phone_number)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Lookups::V2>'
+        end
+      end
+    end
+  end
+end

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

@@ -20,6 +20,7 @@ module Twilio
 
         # Versions
         @v1 = nil
+        @v2 = nil
       end
 
       ##
@@ -28,9 +29,15 @@ module Twilio
         @v1 ||= V1.new self
       end
 
+      ##
+      # Version v2 of lookups
+      def v2
+        @v2 ||= V2.new self
+      end
+
       ##
       # @param [String] phone_number The phone number in
-      #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists
+      #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, which consists
       #   of a + followed by the country code and subscriber number.
       # @return [Twilio::REST::Lookups::V1::PhoneNumberInstance] if phone_number was passed.
       # @return [Twilio::REST::Lookups::V1::PhoneNumberList]