twilio-ruby 3.11.5 → 5.71.0

data/lib/twilio-ruby/rest/pricing/v2/voice/number.rb

@@ -0,0 +1,227 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Pricing < Domain
+      class V2 < Version
+        class VoiceList < ListResource
+          class NumberList < ListResource
+            ##
+            # Initialize the NumberList
+            # @param [Version] version Version that contains the resource
+            # @return [NumberList] NumberList
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Pricing.V2.NumberList>'
+            end
+          end
+
+          class NumberPage < Page
+            ##
+            # Initialize the NumberPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [NumberPage] NumberPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of NumberInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [NumberInstance] NumberInstance
+            def get_instance(payload)
+              NumberInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Pricing.V2.NumberPage>'
+            end
+          end
+
+          class NumberContext < InstanceContext
+            ##
+            # Initialize the NumberContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] destination_number The destination phone number, in
+            #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, for which to
+            #   fetch the origin-based voice pricing information. E.164 format consists of a +
+            #   followed by the country code and subscriber number.
+            # @return [NumberContext] NumberContext
+            def initialize(version, destination_number)
+              super(version)
+
+              # Path Solution
+              @solution = {destination_number: destination_number, }
+              @uri = "/Voice/Numbers/#{CGI.escape(@solution[:destination_number]).gsub("+", "%20")}"
+            end
+
+            ##
+            # Fetch the NumberInstance
+            # @param [String] origination_number The origination phone number, in
+            #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, for which to
+            #   fetch the origin-based voice pricing information. E.164 format consists of a +
+            #   followed by the country code and subscriber number.
+            # @return [NumberInstance] Fetched NumberInstance
+            def fetch(origination_number: :unset)
+              params = Twilio::Values.of({'OriginationNumber' => origination_number, })
+
+              payload = @version.fetch('GET', @uri, params: params)
+
+              NumberInstance.new(@version, payload, destination_number: @solution[:destination_number], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Pricing.V2.NumberContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Pricing.V2.NumberContext #{context}>"
+            end
+          end
+
+          class NumberInstance < InstanceResource
+            ##
+            # Initialize the NumberInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] destination_number The destination phone number, in
+            #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, for which to
+            #   fetch the origin-based voice pricing information. E.164 format consists of a +
+            #   followed by the country code and subscriber number.
+            # @return [NumberInstance] NumberInstance
+            def initialize(version, payload, destination_number: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'destination_number' => payload['destination_number'],
+                  'origination_number' => payload['origination_number'],
+                  'country' => payload['country'],
+                  'iso_country' => payload['iso_country'],
+                  'outbound_call_prices' => payload['outbound_call_prices'],
+                  'inbound_call_price' => payload['inbound_call_price'],
+                  'price_unit' => payload['price_unit'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'destination_number' => destination_number || @properties['destination_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 [NumberContext] NumberContext for this NumberInstance
+            def context
+              unless @instance_context
+                @instance_context = NumberContext.new(@version, @params['destination_number'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The destination phone number, in E.164 format
+            def destination_number
+              @properties['destination_number']
+            end
+
+            ##
+            # @return [String] The origination phone number, in E.164 format
+            def origination_number
+              @properties['origination_number']
+            end
+
+            ##
+            # @return [String] The name of the country
+            def country
+              @properties['country']
+            end
+
+            ##
+            # @return [String] The ISO country code
+            def iso_country
+              @properties['iso_country']
+            end
+
+            ##
+            # @return [Array[String]] The list of OutboundCallPriceWithOrigin records
+            def outbound_call_prices
+              @properties['outbound_call_prices']
+            end
+
+            ##
+            # @return [String] The InboundCallPrice record
+            def inbound_call_price
+              @properties['inbound_call_price']
+            end
+
+            ##
+            # @return [String] The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy)
+            def price_unit
+              @properties['price_unit']
+            end
+
+            ##
+            # @return [String] The absolute URL of the resource
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch the NumberInstance
+            # @param [String] origination_number The origination phone number, in
+            #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, for which to
+            #   fetch the origin-based voice pricing information. E.164 format consists of a +
+            #   followed by the country code and subscriber number.
+            # @return [NumberInstance] Fetched NumberInstance
+            def fetch(origination_number: :unset)
+              context.fetch(origination_number: origination_number, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Pricing.V2.NumberInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Pricing.V2.NumberInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/pricing/v2/voice.rb

@@ -0,0 +1,146 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Pricing < Domain
+      class V2 < Version
+        class VoiceList < ListResource
+          ##
+          # Initialize the VoiceList
+          # @param [Version] version Version that contains the resource
+          # @return [VoiceList] VoiceList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+
+            # Components
+            @countries = nil
+            @numbers = nil
+          end
+
+          ##
+          # Access the countries
+          # @param [String] iso_country The {ISO country
+          #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the origin-based
+          #   voice pricing information to fetch.
+          # @return [CountryList]
+          # @return [CountryContext] if iso_country was passed.
+          def countries(iso_country=:unset)
+            raise ArgumentError, 'iso_country cannot be nil' if iso_country.nil?
+
+            if iso_country != :unset
+              return CountryContext.new(@version, iso_country, )
+            end
+
+              @countries ||= CountryList.new(@version, )
+          end
+
+          ##
+          # Access the numbers
+          # @param [String] destination_number The destination phone number, in
+          #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, for which to
+          #   fetch the origin-based voice pricing information. E.164 format consists of a +
+          #   followed by the country code and subscriber number.
+          # @return [NumberList]
+          # @return [NumberContext] if destination_number was passed.
+          def numbers(destination_number=:unset)
+            raise ArgumentError, 'destination_number cannot be nil' if destination_number.nil?
+
+            if destination_number != :unset
+              return NumberContext.new(@version, destination_number, )
+            end
+
+              @numbers ||= NumberList.new(@version, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Pricing.V2.VoiceList>'
+          end
+        end
+
+        class VoicePage < Page
+          ##
+          # Initialize the VoicePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [VoicePage] VoicePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of VoiceInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [VoiceInstance] VoiceInstance
+          def get_instance(payload)
+            VoiceInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Pricing.V2.VoicePage>'
+          end
+        end
+
+        class VoiceInstance < InstanceResource
+          ##
+          # Initialize the VoiceInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [VoiceInstance] VoiceInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {'name' => payload['name'], 'url' => payload['url'], 'links' => payload['links'], }
+          end
+
+          ##
+          # @return [String] The resource name
+          def name
+            @properties['name']
+          end
+
+          ##
+          # @return [String] The absolute URL of the resource
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] The URLs of the related Countries and Numbers resources
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Pricing.V2.VoiceInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Pricing.V2.VoiceInstance>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Pricing
+      class V2 < Version
+        ##
+        # Initialize the V2 version of Pricing
+        def initialize(domain)
+          super
+          @version = 'v2'
+          @countries = nil
+          @numbers = nil
+          @voice = nil
+        end
+
+        ##
+        # @param [String] iso_country The {ISO country
+        #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the origin-based
+        #   voice pricing information to fetch.
+        # @return [Twilio::REST::Pricing::V2::CountryContext] if iso_country was passed.
+        # @return [Twilio::REST::Pricing::V2::CountryList]
+        def countries(iso_country=:unset)
+          if iso_country.nil?
+              raise ArgumentError, 'iso_country cannot be nil'
+          end
+          if iso_country == :unset
+              @countries ||= CountryList.new self
+          else
+              CountryContext.new(self, iso_country)
+          end
+        end
+
+        ##
+        # @param [String] destination_number The destination phone number, in
+        #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format, for which to
+        #   fetch the origin-based voice pricing information. E.164 format consists of a +
+        #   followed by the country code and subscriber number.
+        # @return [Twilio::REST::Pricing::V2::NumberContext] if destination_number was passed.
+        # @return [Twilio::REST::Pricing::V2::NumberList]
+        def numbers(destination_number=:unset)
+          if destination_number.nil?
+              raise ArgumentError, 'destination_number cannot be nil'
+          end
+          if destination_number == :unset
+              @numbers ||= NumberList.new self
+          else
+              NumberContext.new(self, destination_number)
+          end
+        end
+
+        ##
+        # @return [Twilio::REST::Pricing::V2::VoiceContext]
+        def voice
+          @voice ||= VoiceList.new self
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Pricing::V2>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Pricing < Domain
+      ##
+      # Initialize the Pricing Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://pricing.twilio.com'
+        @host = 'pricing.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+        @v2 = nil
+      end
+
+      ##
+      # Version v1 of pricing
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # Version v2 of pricing
+      def v2
+        @v2 ||= V2.new self
+      end
+
+      ##
+      # @return [Twilio::REST::Pricing::V1::MessagingInstance]
+      def messaging
+        self.v1.messaging()
+      end
+
+      ##
+      # @return [Twilio::REST::Pricing::V1::PhoneNumberInstance]
+      def phone_numbers
+        self.v1.phone_numbers()
+      end
+
+      ##
+      # @return [Twilio::REST::Pricing::V2::VoiceInstance]
+      def voice
+        self.v2.voice()
+      end
+
+      ##
+      # @param [String] iso_country The {ISO country
+      #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2].
+      # @return [Twilio::REST::Pricing::V2::CountryInstance] if iso_country was passed.
+      # @return [Twilio::REST::Pricing::V2::CountryList]
+      def countries(iso_country=:unset)
+        self.v2.countries(iso_country)
+      end
+
+      ##
+      # @param [String] destination_number The destination phone number 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::Pricing::V2::NumberInstance] if destination_number was passed.
+      # @return [Twilio::REST::Pricing::V2::NumberList]
+      def numbers(destination_number=:unset)
+        self.v2.numbers(destination_number)
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::Pricing>'
+      end
+    end
+  end
+end