twilio-ruby 3.11.5 → 5.71.0

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

@@ -0,0 +1,204 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Pricing < Domain
+      class V1 < 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.V1.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.V1.NumberPage>'
+            end
+          end
+
+          class NumberContext < InstanceContext
+            ##
+            # Initialize the NumberContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] number The phone number to fetch.
+            # @return [NumberContext] NumberContext
+            def initialize(version, number)
+              super(version)
+
+              # Path Solution
+              @solution = {number: number, }
+              @uri = "/Voice/Numbers/#{CGI.escape(@solution[:number]).gsub("+", "%20")}"
+            end
+
+            ##
+            # Fetch the NumberInstance
+            # @return [NumberInstance] Fetched NumberInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              NumberInstance.new(@version, payload, number: @solution[:number], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Pricing.V1.NumberContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Pricing.V1.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] number The phone number to fetch.
+            # @return [NumberInstance] NumberInstance
+            def initialize(version, payload, number: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'number' => payload['number'],
+                  'country' => payload['country'],
+                  'iso_country' => payload['iso_country'],
+                  'outbound_call_price' => payload['outbound_call_price'],
+                  'inbound_call_price' => payload['inbound_call_price'],
+                  'price_unit' => payload['price_unit'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'number' => number || @properties['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['number'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The phone number
+            def number
+              @properties['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 [String] The OutboundCallPrice record
+            def outbound_call_price
+              @properties['outbound_call_price']
+            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
+            # @return [NumberInstance] Fetched NumberInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Pricing.V1.NumberInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Pricing.V1.NumberInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,143 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Pricing < Domain
+      class V1 < 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
+            @numbers = nil
+            @countries = nil
+          end
+
+          ##
+          # Access the numbers
+          # @param [String] number The phone number to fetch.
+          # @return [NumberList]
+          # @return [NumberContext] if number was passed.
+          def numbers(number=:unset)
+            raise ArgumentError, 'number cannot be nil' if number.nil?
+
+            if number != :unset
+              return NumberContext.new(@version, number, )
+            end
+
+              @numbers ||= NumberList.new(@version, )
+          end
+
+          ##
+          # Access the countries
+          # @param [String] iso_country The {ISO country
+          #   code}[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the 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
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Pricing.V1.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.V1.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 name
+          def name
+            @properties['name']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] The links
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Pricing.V1.VoiceInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Pricing.V1.VoiceInstance>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Pricing
+      class V1 < Version
+        ##
+        # Initialize the V1 version of Pricing
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @messaging = nil
+          @phone_numbers = nil
+          @voice = nil
+        end
+
+        ##
+        # @return [Twilio::REST::Pricing::V1::MessagingContext]
+        def messaging
+          @messaging ||= MessagingList.new self
+        end
+
+        ##
+        # @return [Twilio::REST::Pricing::V1::PhoneNumberContext]
+        def phone_numbers
+          @phone_numbers ||= PhoneNumberList.new self
+        end
+
+        ##
+        # @return [Twilio::REST::Pricing::V1::VoiceContext]
+        def voice
+          @voice ||= VoiceList.new self
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Pricing::V1>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,280 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Pricing < Domain
+      class V2 < Version
+        class CountryList < ListResource
+          ##
+          # Initialize the CountryList
+          # @param [Version] version Version that contains the resource
+          # @return [CountryList] CountryList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Trunking/Countries"
+          end
+
+          ##
+          # Lists CountryInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @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(limit: nil, page_size: nil)
+            self.stream(limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams CountryInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @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 [Enumerable] Enumerable that will yield up to limit results
+          def stream(limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields CountryInstance records from the API.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          def each
+            limits = @version.read_limits
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+          end
+
+          ##
+          # Retrieve a single page of CountryInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] page_token PageToken provided by the API
+          # @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 CountryInstance
+          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            CountryPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of CountryInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of CountryInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            CountryPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Pricing.V2.CountryList>'
+          end
+        end
+
+        class CountryPage < Page
+          ##
+          # Initialize the CountryPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [CountryPage] CountryPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of CountryInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [CountryInstance] CountryInstance
+          def get_instance(payload)
+            CountryInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Pricing.V2.CountryPage>'
+          end
+        end
+
+        class CountryContext < InstanceContext
+          ##
+          # Initialize the CountryContext
+          # @param [Version] version Version that contains the resource
+          # @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 [CountryContext] CountryContext
+          def initialize(version, iso_country)
+            super(version)
+
+            # Path Solution
+            @solution = {iso_country: iso_country, }
+            @uri = "/Trunking/Countries/#{@solution[:iso_country]}"
+          end
+
+          ##
+          # Fetch the CountryInstance
+          # @return [CountryInstance] Fetched CountryInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            CountryInstance.new(@version, payload, iso_country: @solution[:iso_country], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Pricing.V2.CountryContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Pricing.V2.CountryContext #{context}>"
+          end
+        end
+
+        class CountryInstance < InstanceResource
+          ##
+          # Initialize the CountryInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @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 [CountryInstance] CountryInstance
+          def initialize(version, payload, iso_country: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'country' => payload['country'],
+                'iso_country' => payload['iso_country'],
+                'terminating_prefix_prices' => payload['terminating_prefix_prices'],
+                'originating_call_prices' => payload['originating_call_prices'],
+                'price_unit' => payload['price_unit'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'iso_country' => iso_country || @properties['iso_country'], }
+          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 [CountryContext] CountryContext for this CountryInstance
+          def context
+            unless @instance_context
+              @instance_context = CountryContext.new(@version, @params['iso_country'], )
+            end
+            @instance_context
+          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 TerminatingPrefixPrice records
+          def terminating_prefix_prices
+            @properties['terminating_prefix_prices']
+          end
+
+          ##
+          # @return [Array[String]] The list of OriginatingCallPrice records
+          def originating_call_prices
+            @properties['originating_call_prices']
+          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 CountryInstance
+          # @return [CountryInstance] Fetched CountryInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Pricing.V2.CountryInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Pricing.V2.CountryInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end