twilio-ruby 5.6.0 → 5.33.0

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,35 @@
+##
+# 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'
+          @voice = nil
+        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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -18,6 +20,7 @@ module Twilio
 
         # Versions
         @v1 = nil
+        @v2 = nil
       end
 
       ##
@@ -26,6 +29,12 @@ module Twilio
         @v1 ||= V1.new self
       end
 
+      ##
+      # Version v2 of pricing
+      def v2
+        @v2 ||= V2.new self
+      end
+
       ##
       # @return [Twilio::REST::Pricing::V1::MessagingInstance]
       def messaging
@@ -39,9 +48,9 @@ module Twilio
       end
 
       ##
-      # @return [Twilio::REST::Pricing::V1::VoiceInstance]
+      # @return [Twilio::REST::Pricing::V2::VoiceInstance]
       def voice
-        self.v1.voice()
+        self.v2.voice()
       end
 
       ##

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,7 +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 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)
@@ -28,12 +31,19 @@ module Twilio
             ##
             # Retrieve a single page of PhoneNumberInstance records from the API.
             # Request is executed immediately.
-            # @param [String] sid A 34 character string that uniquely identifies this Phone
-            #   Number.
-            # @param [String] phone_number The phone_number
+            # @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
-            def create(sid: :unset, phone_number: :unset)
-              data = Twilio::Values.of({'Sid' => sid, 'PhoneNumber' => phone_number})
+            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',
@@ -41,7 +51,7 @@ module Twilio
                   data: data
               )
 
-              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -73,7 +83,7 @@ module Twilio
             def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -85,7 +95,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -154,7 +164,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [PhoneNumberInstance] PhoneNumberInstance
             def get_instance(payload)
-              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -170,21 +180,23 @@ module Twilio
             ##
             # Initialize the PhoneNumberContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique SID identifier of the Service.
-            # @param [String] sid A 34 character string that uniquely identifies this Phone
-            #   Number.
+            # @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)
 
               # Path Solution
-              @solution = {service_sid: service_sid, sid: sid}
+              @solution = {service_sid: service_sid, sid: sid, }
               @uri = "/Services/#{@solution[:service_sid]}/PhoneNumbers/#{@solution[:sid]}"
             end
 
             ##
             # Deletes the PhoneNumberInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -201,7 +213,36 @@ module Twilio
                   params,
               )
 
-              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              PhoneNumberInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Update the PhoneNumberInstance
+            # @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,
+              )
+
+              PhoneNumberInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
@@ -210,6 +251,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
 
           ##
@@ -219,9 +267,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 Service.
-            # @param [String] sid A 34 character string that uniquely identifies this Phone
-            #   Number.
+            # @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)
@@ -238,11 +287,13 @@ module Twilio
                   'iso_country' => payload['iso_country'],
                   'capabilities' => payload['capabilities'],
                   'url' => payload['url'],
+                  'is_reserved' => payload['is_reserved'],
+                  'in_use' => payload['in_use'].to_i,
               }
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -251,74 +302,86 @@ module Twilio
             # @return [PhoneNumberContext] PhoneNumberContext for this PhoneNumberInstance
             def context
               unless @instance_context
-                @instance_context = PhoneNumberContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = PhoneNumberContext.new(@version, @params['service_sid'], @params['sid'], )
               end
               @instance_context
             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 created
+            # @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 the phone number for manual assignment to participants only
+            def is_reserved
+              @properties['is_reserved']
+            end
+
+            ##
+            # @return [String] The number of open session assigned to the number.
+            def in_use
+              @properties['in_use']
+            end
+
             ##
             # Deletes the PhoneNumberInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
@@ -330,6 +393,17 @@ module Twilio
               context.fetch
             end
 
+            ##
+            # Update the PhoneNumberInstance
+            # @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)
+              context.update(is_reserved: is_reserved, )
+            end
+
             ##
             # Provide a user friendly representation
             def to_s