twilio-ruby 5.15.1 → 5.58.1

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -27,7 +27,9 @@ module Twilio
 
           ##
           # Access the countries
-          # @param [String] iso_country The iso_country
+          # @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)

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -85,11 +85,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               CountryPage.new(@version, response, @solution)
             end
 
@@ -146,7 +144,9 @@ module Twilio
             ##
             # Initialize the CountryContext
             # @param [Version] version Version that contains the resource
-            # @param [String] iso_country The iso_country
+            # @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 [CountryContext] CountryContext
             def initialize(version, iso_country)
               super(version)
@@ -157,16 +157,10 @@ module Twilio
             end
 
             ##
-            # Fetch a CountryInstance
+            # Fetch the CountryInstance
             # @return [CountryInstance] Fetched CountryInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               CountryInstance.new(@version, payload, iso_country: @solution[:iso_country], )
             end
@@ -177,6 +171,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Pricing.V1.CountryContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Pricing.V1.CountryContext #{context}>"
+            end
           end
 
           class CountryInstance < InstanceResource
@@ -184,7 +185,9 @@ module Twilio
             # 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
+            # @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 [CountryInstance] CountryInstance
             def initialize(version, payload, iso_country: nil)
               super(version)
@@ -193,10 +196,10 @@ module Twilio
               @properties = {
                   'country' => payload['country'],
                   'iso_country' => payload['iso_country'],
-                  'url' => payload['url'],
                   'outbound_prefix_prices' => payload['outbound_prefix_prices'],
                   'inbound_call_prices' => payload['inbound_call_prices'],
                   'price_unit' => payload['price_unit'],
+                  'url' => payload['url'],
               }
 
               # Context
@@ -216,7 +219,7 @@ module Twilio
             end
 
             ##
-            # @return [String] Name of the country
+            # @return [String] The name of the country
             def country
               @properties['country']
             end
@@ -228,31 +231,31 @@ module Twilio
             end
 
             ##
-            # @return [String] The outbound_prefix_prices
+            # @return [Array[String]] The list of OutboundPrefixPrice records
             def outbound_prefix_prices
               @properties['outbound_prefix_prices']
             end
 
             ##
-            # @return [String] The inbound_call_prices
+            # @return [Array[String]] The list of InboundCallPrice records
             def inbound_call_prices
               @properties['inbound_call_prices']
             end
 
             ##
-            # @return [String] The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy).
+            # @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 url
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
 
             ##
-            # Fetch a CountryInstance
+            # Fetch the CountryInstance
             # @return [CountryInstance] Fetched CountryInstance
             def fetch
               context.fetch

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -63,27 +63,21 @@ module Twilio
             ##
             # Initialize the NumberContext
             # @param [Version] version Version that contains the resource
-            # @param [String] number The number
+            # @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/#{@solution[:number]}"
+              @uri = "/Voice/Numbers/#{CGI.escape(@solution[:number]).gsub("+", "%20")}"
             end
 
             ##
-            # Fetch a NumberInstance
+            # Fetch the NumberInstance
             # @return [NumberInstance] Fetched NumberInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               NumberInstance.new(@version, payload, number: @solution[:number], )
             end
@@ -94,6 +88,13 @@ module Twilio
               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
@@ -101,7 +102,7 @@ module Twilio
             # Initialize the NumberInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] number The number
+            # @param [String] number The phone number to fetch.
             # @return [NumberInstance] NumberInstance
             def initialize(version, payload, number: nil)
               super(version)
@@ -134,13 +135,13 @@ module Twilio
             end
 
             ##
-            # @return [String] The number
+            # @return [String] The phone number
             def number
               @properties['number']
             end
 
             ##
-            # @return [String] Name of the country
+            # @return [String] The name of the country
             def country
               @properties['country']
             end
@@ -152,31 +153,31 @@ module Twilio
             end
 
             ##
-            # @return [String] See OutboundCallPrice record
+            # @return [String] The OutboundCallPrice record
             def outbound_call_price
               @properties['outbound_call_price']
             end
 
             ##
-            # @return [String] See InboundCallPrice record (returned as null if the Phone Number provided is not a Twilio number owned by this account)
+            # @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).
+            # @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 url
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
 
             ##
-            # Fetch a NumberInstance
+            # Fetch the NumberInstance
             # @return [NumberInstance] Fetched NumberInstance
             def fetch
               context.fetch

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -28,7 +28,7 @@ module Twilio
 
           ##
           # Access the numbers
-          # @param [String] number The number
+          # @param [String] number The phone number to fetch.
           # @return [NumberList]
           # @return [NumberContext] if number was passed.
           def numbers(number=:unset)
@@ -43,7 +43,9 @@ module Twilio
 
           ##
           # Access the countries
-          # @param [String] iso_country The iso_country
+          # @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)

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio

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