twilio-ruby 5.19.0 → 5.74.2

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -63,29 +63,30 @@ module Twilio
             ##
             # Initialize the NumberContext
             # @param [Version] version Version that contains the resource
-            # @param [String] destination_number This fetches the origin-based voice pricing
-            #   information for a phone number
+            # @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/#{@solution[:destination_number]}"
+              @uri = "/Voice/Numbers/#{CGI.escape(@solution[:destination_number]).gsub("+", "%20")}"
             end
 
             ##
-            # Fetch a NumberInstance
-            # @param [String] origination_number The origination_number
+            # 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,
-              )
+              payload = @version.fetch('GET', @uri, params: params)
 
               NumberInstance.new(@version, payload, destination_number: @solution[:destination_number], )
             end
@@ -96,6 +97,13 @@ module Twilio
               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
@@ -103,8 +111,10 @@ module Twilio
             # Initialize the NumberInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] destination_number This fetches the origin-based voice pricing
-            #   information for a phone number
+            # @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)
@@ -138,19 +148,19 @@ module Twilio
             end
 
             ##
-            # @return [String] The destination phone number, in E.164
+            # @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
+            # @return [String] The origination phone number, in E.164 format
             def origination_number
               @properties['origination_number']
             end
 
             ##
-            # @return [String] Name of the country
+            # @return [String] The name of the country
             def country
               @properties['country']
             end
@@ -162,32 +172,35 @@ module Twilio
             end
 
             ##
-            # @return [String] List of OutboundCallPriceWithOrigin records
+            # @return [Array[String]] The list of OutboundCallPriceWithOrigin records
             def outbound_call_prices
               @properties['outbound_call_prices']
             end
 
             ##
-            # @return [String] List of InboundCallPrice records
+            # @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 of this resource.
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
 
             ##
-            # Fetch a NumberInstance
-            # @param [String] origination_number The origination_number
+            # 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, )

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -28,8 +28,9 @@ module Twilio
 
           ##
           # Access the countries
-          # @param [String] iso_country This fetches the origin-based voice pricing
-          #   information for a specific country
+          # @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)
@@ -44,8 +45,10 @@ module Twilio
 
           ##
           # Access the numbers
-          # @param [String] destination_number This fetches the origin-based voice pricing
-          #   information for a phone number
+          # @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)
@@ -108,19 +111,19 @@ module Twilio
           end
 
           ##
-          # @return [String] The name
+          # @return [String] The resource name
           def name
             @properties['name']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the resource
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] The URLs of the related Countries and Numbers resources
           def links
             @properties['links']
           end

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,9 +15,46 @@ module Twilio
         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

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -53,6 +53,25 @@ module Twilio
         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

data/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -17,8 +17,8 @@ module Twilio
             ##
             # Initialize the PhoneNumberList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique SID identifier of the parent
-            #   [Service](https://www.twilio.com/docs/proxy/api/service).
+            # @param [String] service_sid The SID of the PhoneNumber resource's parent
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
             # @return [PhoneNumberList] PhoneNumberList
             def initialize(version, service_sid: nil)
               super(version)
@@ -29,26 +29,24 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of PhoneNumberInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] sid A Twilio
-            #   [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incoming-phone-numbers) Sid that represents the Twilio Number you would like to assign to your Proxy Service (e.g. `PN1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d`).
-            # @param [String] phone_number A string that represents the Twilio Number you
-            #   would like to assign to your Proxy Service. Provide number in
-            #   [E.164](https://en.wikipedia.org/wiki/E.164) format (e.g. `+16175551212`).
-            # @param [Boolean] is_reserved Whether or not the number should be excluded from
-            #   being assigned to a participant using proxy pool logic. See [Reserved Phone
-            #   Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more
+            # Create the PhoneNumberInstance
+            # @param [String] sid The SID of a Twilio
+            #   {IncomingPhoneNumber}[https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource]
+            #   resource that represents the Twilio Number you would like to assign to your
+            #   Proxy Service.
+            # @param [String] phone_number The phone number in
+            #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format.  E.164 phone
+            #   numbers consist of a + followed by the country code and subscriber number
+            #   without punctuation characters. For example, +14155551234.
+            # @param [Boolean] is_reserved Whether the new phone number should be reserved and
+            #   not be assigned to a participant using proxy pool logic. See {Reserved Phone
+            #   Numbers}[https://www.twilio.com/docs/proxy/reserved-phone-numbers] for more
             #   information.
-            # @return [PhoneNumberInstance] Newly created PhoneNumberInstance
+            # @return [PhoneNumberInstance] Created PhoneNumberInstance
             def create(sid: :unset, phone_number: :unset, is_reserved: :unset)
               data = Twilio::Values.of({'Sid' => sid, 'PhoneNumber' => phone_number, 'IsReserved' => is_reserved, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -114,11 +112,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               PhoneNumberPage.new(@version, response, @solution)
             end
 
@@ -179,10 +175,11 @@ module Twilio
             ##
             # Initialize the PhoneNumberContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique SID identifier of the parent
-            #   [Service](https://www.twilio.com/docs/proxy/api/service).
-            # @param [String] sid A 34 character string that uniquely identifies the Phone
-            #   Number to fetch (e.g. `PN1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d`).
+            # @param [String] service_sid The SID of the parent
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] of the PhoneNumber
+            #   resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   PhoneNumber resource to fetch.
             # @return [PhoneNumberContext] PhoneNumberContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -193,23 +190,17 @@ module Twilio
             end
 
             ##
-            # Deletes the PhoneNumberInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the PhoneNumberInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
-            # Fetch a PhoneNumberInstance
+            # Fetch the PhoneNumberInstance
             # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               PhoneNumberInstance.new(
                   @version,
@@ -221,19 +212,15 @@ module Twilio
 
             ##
             # Update the PhoneNumberInstance
-            # @param [Boolean] is_reserved Whether or not the number should be excluded from
-            #   being assigned to a participant using proxy pool logic. See [Reserved Phone
-            #   Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more
+            # @param [Boolean] is_reserved Whether the phone number should be reserved and not
+            #   be assigned to a participant using proxy pool logic. See {Reserved Phone
+            #   Numbers}[https://www.twilio.com/docs/proxy/reserved-phone-numbers] for more
             #   information.
             # @return [PhoneNumberInstance] Updated PhoneNumberInstance
             def update(is_reserved: :unset)
               data = Twilio::Values.of({'IsReserved' => is_reserved, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               PhoneNumberInstance.new(
                   @version,
@@ -249,6 +236,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Proxy.V1.PhoneNumberContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Proxy.V1.PhoneNumberContext #{context}>"
+            end
           end
 
           ##
@@ -258,10 +252,10 @@ module Twilio
             # Initialize the PhoneNumberInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The unique SID identifier of the parent
-            #   [Service](https://www.twilio.com/docs/proxy/api/service).
-            # @param [String] sid A 34 character string that uniquely identifies the Phone
-            #   Number to fetch (e.g. `PN1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d`).
+            # @param [String] service_sid The SID of the PhoneNumber resource's parent
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   PhoneNumber resource to fetch.
             # @return [PhoneNumberInstance] PhoneNumberInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -279,6 +273,7 @@ module Twilio
                   'capabilities' => payload['capabilities'],
                   'url' => payload['url'],
                   'is_reserved' => payload['is_reserved'],
+                  'in_use' => payload['in_use'] == nil ? payload['in_use'] : payload['in_use'].to_i,
               }
 
               # Context
@@ -298,80 +293,86 @@ module Twilio
             end
 
             ##
-            # @return [String] A string that uniquely identifies this Phone Number.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] Account Sid.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] Service Sid.
+            # @return [String] The SID of the PhoneNumber resource's parent Service resource
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [Time] The date this Phone Number was added to the service
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this Phone Number was updated
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The phone number.
+            # @return [String] The phone number in E.164 format
             def phone_number
               @properties['phone_number']
             end
 
             ##
-            # @return [String] A human-readable description of this resource.
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] ISO Country Code,
+            # @return [String] The ISO Country Code
             def iso_country
               @properties['iso_country']
             end
 
             ##
-            # @return [String] A list of capabilities.
+            # @return [String] The capabilities of the phone number
             def capabilities
               @properties['capabilities']
             end
 
             ##
-            # @return [String] The URL of this resource.
+            # @return [String] The absolute URL of the PhoneNumber resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [Boolean] Reserve for manual assignment to participants only.
+            # @return [Boolean] Reserve the phone number for manual assignment to participants only
             def is_reserved
               @properties['is_reserved']
             end
 
             ##
-            # Deletes the PhoneNumberInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [String] The number of open session assigned to the number.
+            def in_use
+              @properties['in_use']
+            end
+
+            ##
+            # Delete the PhoneNumberInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
-            # Fetch a PhoneNumberInstance
+            # Fetch the PhoneNumberInstance
             # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
             def fetch
               context.fetch
@@ -379,9 +380,9 @@ module Twilio
 
             ##
             # Update the PhoneNumberInstance
-            # @param [Boolean] is_reserved Whether or not the number should be excluded from
-            #   being assigned to a participant using proxy pool logic. See [Reserved Phone
-            #   Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more
+            # @param [Boolean] is_reserved Whether the phone number should be reserved and not
+            #   be assigned to a participant using proxy pool logic. See {Reserved Phone
+            #   Numbers}[https://www.twilio.com/docs/proxy/reserved-phone-numbers] for more
             #   information.
             # @return [PhoneNumberInstance] Updated PhoneNumberInstance
             def update(is_reserved: :unset)