twilio-ruby 5.5.1 → 5.58.3

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)
@@ -26,22 +29,26 @@ module Twilio
             end
 
             ##
-            # 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
-            # @return [PhoneNumberInstance] Newly created PhoneNumberInstance
-            def create(sid: :unset, phone_number: :unset)
-              data = Twilio::Values.of({'Sid' => sid, 'PhoneNumber' => phone_number})
-
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
-
-              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid])
+            # 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] 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)
+
+              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -73,7 +80,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 +92,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],
@@ -105,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
 
@@ -154,7 +159,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,38 +175,59 @@ 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
+            # 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)
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
+              PhoneNumberInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  sid: @solution[:sid],
               )
+            end
 
-              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+            ##
+            # 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 +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
 
           ##
@@ -219,9 +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 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 +272,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,85 +287,108 @@ 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
 
             ##
-            # Deletes the PhoneNumberInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @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
+
+            ##
+            # 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
             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