twilio-ruby 3.11.5 → 5.71.0

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

@@ -0,0 +1,60 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class IpMessaging
+      class V2 < Version
+        ##
+        # Initialize the V2 version of IpMessaging
+        def initialize(domain)
+          super
+          @version = 'v2'
+          @credentials = nil
+          @services = nil
+        end
+
+        ##
+        # @param [String] sid The sid
+        # @return [Twilio::REST::Ip_messaging::V2::CredentialContext] if sid was passed.
+        # @return [Twilio::REST::Ip_messaging::V2::CredentialList]
+        def credentials(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @credentials ||= CredentialList.new self
+          else
+              CredentialContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The sid
+        # @return [Twilio::REST::Ip_messaging::V2::ServiceContext] if sid was passed.
+        # @return [Twilio::REST::Ip_messaging::V2::ServiceList]
+        def services(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
+          else
+              ServiceContext.new(self, sid)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::IpMessaging::V2>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class IpMessaging < Domain
+      ##
+      # Initialize the IpMessaging Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://ip-messaging.twilio.com'
+        @host = 'ip-messaging.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+        @v2 = nil
+      end
+
+      ##
+      # Version v1 of ip_messaging
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # Version v2 of ip_messaging
+      def v2
+        @v2 ||= V2.new self
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Ip_messaging::V2::CredentialInstance] if sid was passed.
+      # @return [Twilio::REST::Ip_messaging::V2::CredentialList]
+      def credentials(sid=:unset)
+        self.v2.credentials(sid)
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Ip_messaging::V2::ServiceInstance] if sid was passed.
+      # @return [Twilio::REST::Ip_messaging::V2::ServiceList]
+      def services(sid=:unset)
+        self.v2.services(sid)
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::IpMessaging>'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,247 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Lookups < Domain
+      class V1 < Version
+        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.V1.PhoneNumberList>'
+          end
+        end
+
+        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.V1.PhoneNumberPage>'
+          end
+        end
+
+        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}[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)
+            super(version)
+
+            # Path Solution
+            @solution = {phone_number: phone_number, }
+            @uri = "/PhoneNumbers/#{CGI.escape(@solution[:phone_number]).gsub("+", "%20")}"
+          end
+
+          ##
+          # 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
+          #   fetch. This is used to specify the country when the phone number is provided in
+          #   a national format.
+          # @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 [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
+          def fetch(country_code: :unset, type: :unset, add_ons: :unset, add_ons_data: :unset)
+            params = Twilio::Values.of({
+                'CountryCode' => country_code,
+                'Type' => Twilio.serialize_list(type) { |e| e },
+                'AddOns' => Twilio.serialize_list(add_ons) { |e| e },
+            })
+            params.merge!(Twilio.prefixed_collapsible_map(add_ons_data, 'AddOns'))
+
+            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.V1.PhoneNumberContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Lookups.V1.PhoneNumberContext #{context}>"
+          end
+        end
+
+        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}[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)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'caller_name' => payload['caller_name'],
+                'country_code' => payload['country_code'],
+                'phone_number' => payload['phone_number'],
+                'national_format' => payload['national_format'],
+                'carrier' => payload['carrier'],
+                'add_ons' => payload['add_ons'],
+                '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 [Hash] The name of the phone number's owner
+          def caller_name
+            @properties['caller_name']
+          end
+
+          ##
+          # @return [String] The ISO country code for the phone number
+          def country_code
+            @properties['country_code']
+          end
+
+          ##
+          # @return [String] The phone number in E.164 format
+          def phone_number
+            @properties['phone_number']
+          end
+
+          ##
+          # @return [String] The phone number, in national format
+          def national_format
+            @properties['national_format']
+          end
+
+          ##
+          # @return [Hash] The telecom company that provides the phone number
+          def carrier
+            @properties['carrier']
+          end
+
+          ##
+          # @return [Hash] A JSON string with the results of the Add-ons you specified
+          def add_ons
+            @properties['add_ons']
+          end
+
+          ##
+          # @return [String] The absolute URL of the resource
+          def url
+            @properties['url']
+          end
+
+          ##
+          # 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
+          #   fetch. This is used to specify the country when the phone number is provided in
+          #   a national format.
+          # @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 [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
+          def fetch(country_code: :unset, type: :unset, add_ons: :unset, add_ons_data: :unset)
+            context.fetch(country_code: country_code, type: type, add_ons: add_ons, add_ons_data: add_ons_data, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Lookups.V1.PhoneNumberInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Lookups.V1.PhoneNumberInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Lookups
+      class V1 < Version
+        ##
+        # Initialize the V1 version of Lookups
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @phone_numbers = nil
+        end
+
+        ##
+        # @param [String] phone_number The phone number to lookup in
+        #   {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'
+          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::V1>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,261 @@
+##
+# 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.
+          # @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.
+          # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
+          def fetch(fields: :unset, country_code: :unset)
+            params = Twilio::Values.of({'Fields' => fields, 'CountryCode' => country_code, })
+
+            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'],
+                '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 [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.
+          # @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.
+          # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
+          def fetch(fields: :unset, country_code: :unset)
+            context.fetch(fields: fields, country_code: country_code, )
+          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