twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,7 +17,8 @@ module Twilio
             ##
             # Initialize the ShortCodeList
             # @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 ShortCode resource's parent
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
             # @return [ShortCodeList] ShortCodeList
             def initialize(version, service_sid: nil)
               super(version)
@@ -26,21 +29,17 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of ShortCodeInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] sid A 34 character string that uniquely identifies this Short
-            #   Code.
-            # @return [ShortCodeInstance] Newly created ShortCodeInstance
+            # Create the ShortCodeInstance
+            # @param [String] sid The SID of a Twilio
+            #   {ShortCode}[https://www.twilio.com/docs/sms/api/short-code] resource that
+            #   represents the short code you would like to assign to your Proxy Service.
+            # @return [ShortCodeInstance] Created ShortCodeInstance
             def create(sid: nil)
-              data = Twilio::Values.of({'Sid' => sid})
+              data = Twilio::Values.of({'Sid' => sid, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -72,7 +71,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
@@ -84,7 +83,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],
@@ -104,11 +103,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               ShortCodePage.new(@version, response, @solution)
             end
 
@@ -153,7 +150,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [ShortCodeInstance] ShortCodeInstance
             def get_instance(payload)
-              ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -169,38 +166,49 @@ module Twilio
             ##
             # Initialize the ShortCodeContext
             # @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 Short
-            #   Code.
+            # @param [String] service_sid The SID of the parent
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] to fetch the resource
+            #   from.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   ShortCode resource to fetch.
             # @return [ShortCodeContext] ShortCodeContext
             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]}/ShortCodes/#{@solution[:sid]}"
             end
 
             ##
-            # Deletes the ShortCodeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the ShortCodeInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
-            # Fetch a ShortCodeInstance
+            # Fetch the ShortCodeInstance
             # @return [ShortCodeInstance] Fetched ShortCodeInstance
             def fetch
-              params = Twilio::Values.of({})
+              payload = @version.fetch('GET', @uri)
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
+            end
 
-              ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+            ##
+            # Update the ShortCodeInstance
+            # @param [Boolean] is_reserved Whether the short code 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 [ShortCodeInstance] Updated ShortCodeInstance
+            def update(is_reserved: :unset)
+              data = Twilio::Values.of({'IsReserved' => is_reserved, })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
@@ -209,6 +217,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Proxy.V1.ShortCodeContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Proxy.V1.ShortCodeContext #{context}>"
+            end
           end
 
           ##
@@ -218,9 +233,10 @@ module Twilio
             # Initialize the ShortCodeInstance
             # @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 Short
-            #   Code.
+            # @param [String] service_sid The SID of the ShortCode resource's parent
+            #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   ShortCode resource to fetch.
             # @return [ShortCodeInstance] ShortCodeInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -236,11 +252,12 @@ module Twilio
                   'iso_country' => payload['iso_country'],
                   'capabilities' => payload['capabilities'],
                   'url' => payload['url'],
+                  'is_reserved' => payload['is_reserved'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -249,79 +266,96 @@ module Twilio
             # @return [ShortCodeContext] ShortCodeContext for this ShortCodeInstance
             def context
               unless @instance_context
-                @instance_context = ShortCodeContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = ShortCodeContext.new(@version, @params['service_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] A string that uniquely identifies this Short Code.
+            # @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 resource's parent Service
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [Time] The date this Short Code 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 Short Code 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] Shortcode.
+            # @return [String] The short code's number
             def short_code
               @properties['short_code']
             end
 
             ##
-            # @return [String] ISO Country Code,
+            # @return [String] The ISO Country Code
             def iso_country
               @properties['iso_country']
             end
 
             ##
-            # @return [String] Nested resource URLs.
+            # @return [String] The capabilities of the short code
             def capabilities
               @properties['capabilities']
             end
 
             ##
-            # @return [String] The URL of this resource.
+            # @return [String] The absolute URL of the ShortCode resource
             def url
               @properties['url']
             end
 
             ##
-            # Deletes the ShortCodeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] Whether the short code should be reserved for manual assignment to participants only
+            def is_reserved
+              @properties['is_reserved']
+            end
+
+            ##
+            # Delete the ShortCodeInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
-            # Fetch a ShortCodeInstance
+            # Fetch the ShortCodeInstance
             # @return [ShortCodeInstance] Fetched ShortCodeInstance
             def fetch
               context.fetch
             end
 
+            ##
+            # Update the ShortCodeInstance
+            # @param [Boolean] is_reserved Whether the short code 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 [ShortCodeInstance] Updated ShortCodeInstance
+            def update(is_reserved: :unset)
+              context.update(is_reserved: is_reserved, )
+            end
+
             ##
             # Provide a user friendly representation
             def to_s