twilio-ruby 5.15.1 → 5.58.1

data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -17,9 +17,10 @@ module Twilio
                 ##
                 # Initialize the IpAddressList
                 # @param [Version] version Version that contains the resource
-                # @param [String] account_sid The unique id of the Account that responsible for
+                # @param [String] account_sid The unique id of the Account that is responsible for
                 #   this resource.
-                # @param [String] ip_access_control_list_sid The ip_access_control_list_sid
+                # @param [String] ip_access_control_list_sid The unique id of the
+                #   IpAccessControlList resource that includes this resource.
                 # @return [IpAddressList] IpAddressList
                 def initialize(version, account_sid: nil, ip_access_control_list_sid: nil)
                   super(version)
@@ -90,11 +91,9 @@ module Twilio
                       'Page' => page_number,
                       'PageSize' => page_size,
                   })
-                  response = @version.page(
-                      'GET',
-                      @uri,
-                      params
-                  )
+
+                  response = @version.page('GET', @uri, params: params)
+
                   IpAddressPage.new(@version, response, @solution)
                 end
 
@@ -112,12 +111,16 @@ module Twilio
                 end
 
                 ##
-                # Retrieve a single page of IpAddressInstance records from the API.
-                # Request is executed immediately.
-                # @param [String] friendly_name The friendly_name
-                # @param [String] ip_address The ip_address
-                # @param [String] cidr_prefix_length The cidr_prefix_length
-                # @return [IpAddressInstance] Newly created IpAddressInstance
+                # Create the IpAddressInstance
+                # @param [String] friendly_name A human readable descriptive text for this
+                #   resource, up to 64 characters long.
+                # @param [String] ip_address An IP address in dotted decimal notation from which
+                #   you want to accept traffic. Any SIP requests from this IP address will be
+                #   allowed by Twilio. IPv4 only supported today.
+                # @param [String] cidr_prefix_length An integer representing the length of the
+                #   CIDR prefix to use with this IP address when accepting traffic. By default the
+                #   entire IP address is used.
+                # @return [IpAddressInstance] Created IpAddressInstance
                 def create(friendly_name: nil, ip_address: nil, cidr_prefix_length: :unset)
                   data = Twilio::Values.of({
                       'FriendlyName' => friendly_name,
@@ -125,11 +128,7 @@ module Twilio
                       'CidrPrefixLength' => cidr_prefix_length,
                   })
 
-                  payload = @version.create(
-                      'POST',
-                      @uri,
-                      data: data
-                  )
+                  payload = @version.create('POST', @uri, data: data)
 
                   IpAddressInstance.new(
                       @version,
@@ -184,9 +183,13 @@ module Twilio
                 ##
                 # Initialize the IpAddressContext
                 # @param [Version] version Version that contains the resource
-                # @param [String] account_sid The account_sid
-                # @param [String] ip_access_control_list_sid The ip_access_control_list_sid
-                # @param [String] sid The sid
+                # @param [String] account_sid The unique id of the
+                #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this
+                #   resource.
+                # @param [String] ip_access_control_list_sid The IpAccessControlList Sid that
+                #   identifies the IpAddress resources to fetch.
+                # @param [String] sid A 34 character string that uniquely identifies the IpAddress
+                #   resource to fetch.
                 # @return [IpAddressContext] IpAddressContext
                 def initialize(version, account_sid, ip_access_control_list_sid, sid)
                   super(version)
@@ -201,16 +204,10 @@ module Twilio
                 end
 
                 ##
-                # Fetch a IpAddressInstance
+                # Fetch the IpAddressInstance
                 # @return [IpAddressInstance] Fetched IpAddressInstance
                 def fetch
-                  params = Twilio::Values.of({})
-
-                  payload = @version.fetch(
-                      'GET',
-                      @uri,
-                      params,
-                  )
+                  payload = @version.fetch('GET', @uri)
 
                   IpAddressInstance.new(
                       @version,
@@ -223,9 +220,14 @@ module Twilio
 
                 ##
                 # Update the IpAddressInstance
-                # @param [String] ip_address The ip_address
-                # @param [String] friendly_name The friendly_name
-                # @param [String] cidr_prefix_length The cidr_prefix_length
+                # @param [String] ip_address An IP address in dotted decimal notation from which
+                #   you want to accept traffic. Any SIP requests from this IP address will be
+                #   allowed by Twilio. IPv4 only supported today.
+                # @param [String] friendly_name A human readable descriptive text for this
+                #   resource, up to 64 characters long.
+                # @param [String] cidr_prefix_length An integer representing the length of the
+                #   CIDR prefix to use with this IP address when accepting traffic. By default the
+                #   entire IP address is used.
                 # @return [IpAddressInstance] Updated IpAddressInstance
                 def update(ip_address: :unset, friendly_name: :unset, cidr_prefix_length: :unset)
                   data = Twilio::Values.of({
@@ -234,11 +236,7 @@ module Twilio
                       'CidrPrefixLength' => cidr_prefix_length,
                   })
 
-                  payload = @version.update(
-                      'POST',
-                      @uri,
-                      data: data,
-                  )
+                  payload = @version.update('POST', @uri, data: data)
 
                   IpAddressInstance.new(
                       @version,
@@ -250,10 +248,10 @@ module Twilio
                 end
 
                 ##
-                # Deletes the IpAddressInstance
-                # @return [Boolean] true if delete succeeds, true otherwise
+                # Delete the IpAddressInstance
+                # @return [Boolean] true if delete succeeds, false otherwise
                 def delete
-                  @version.delete('delete', @uri)
+                   @version.delete('DELETE', @uri)
                 end
 
                 ##
@@ -262,6 +260,13 @@ module Twilio
                   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                   "#<Twilio.Api.V2010.IpAddressContext #{context}>"
                 end
+
+                ##
+                # Provide a detailed, user friendly representation
+                def inspect
+                  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                  "#<Twilio.Api.V2010.IpAddressContext #{context}>"
+                end
               end
 
               class IpAddressInstance < InstanceResource
@@ -269,10 +274,12 @@ module Twilio
                 # Initialize the IpAddressInstance
                 # @param [Version] version Version that contains the resource
                 # @param [Hash] payload payload that contains response from Twilio
-                # @param [String] account_sid The unique id of the Account that responsible for
+                # @param [String] account_sid The unique id of the Account that is responsible for
                 #   this resource.
-                # @param [String] ip_access_control_list_sid The ip_access_control_list_sid
-                # @param [String] sid The sid
+                # @param [String] ip_access_control_list_sid The unique id of the
+                #   IpAccessControlList resource that includes this resource.
+                # @param [String] sid A 34 character string that uniquely identifies the IpAddress
+                #   resource to fetch.
                 # @return [IpAddressInstance] IpAddressInstance
                 def initialize(version, payload, account_sid: nil, ip_access_control_list_sid: nil, sid: nil)
                   super(version)
@@ -322,7 +329,7 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The unique id of the Account that responsible for this resource.
+                # @return [String] The unique id of the Account that is responsible for this resource.
                 def account_sid
                   @properties['account_sid']
                 end
@@ -346,7 +353,7 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The ip_access_control_list_sid
+                # @return [String] The unique id of the IpAccessControlList resource that includes this resource.
                 def ip_access_control_list_sid
                   @properties['ip_access_control_list_sid']
                 end
@@ -370,7 +377,7 @@ module Twilio
                 end
 
                 ##
-                # Fetch a IpAddressInstance
+                # Fetch the IpAddressInstance
                 # @return [IpAddressInstance] Fetched IpAddressInstance
                 def fetch
                   context.fetch
@@ -378,9 +385,14 @@ module Twilio
 
                 ##
                 # Update the IpAddressInstance
-                # @param [String] ip_address The ip_address
-                # @param [String] friendly_name The friendly_name
-                # @param [String] cidr_prefix_length The cidr_prefix_length
+                # @param [String] ip_address An IP address in dotted decimal notation from which
+                #   you want to accept traffic. Any SIP requests from this IP address will be
+                #   allowed by Twilio. IPv4 only supported today.
+                # @param [String] friendly_name A human readable descriptive text for this
+                #   resource, up to 64 characters long.
+                # @param [String] cidr_prefix_length An integer representing the length of the
+                #   CIDR prefix to use with this IP address when accepting traffic. By default the
+                #   entire IP address is used.
                 # @return [IpAddressInstance] Updated IpAddressInstance
                 def update(ip_address: :unset, friendly_name: :unset, cidr_prefix_length: :unset)
                   context.update(
@@ -391,8 +403,8 @@ module Twilio
                 end
 
                 ##
-                # Deletes the IpAddressInstance
-                # @return [Boolean] true if delete succeeds, true otherwise
+                # Delete the IpAddressInstance
+                # @return [Boolean] true if delete succeeds, false otherwise
                 def delete
                   context.delete
                 end

data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -88,11 +88,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 IpAccessControlListPage.new(@version, response, @solution)
               end
 
@@ -110,19 +108,14 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of IpAccessControlListInstance records from the API.
-              # Request is executed immediately.
+              # Create the IpAccessControlListInstance
               # @param [String] friendly_name A human readable descriptive text that describes
               #   the IpAccessControlList, up to 64 characters long.
-              # @return [IpAccessControlListInstance] Newly created IpAccessControlListInstance
+              # @return [IpAccessControlListInstance] Created IpAccessControlListInstance
               def create(friendly_name: nil)
                 data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 IpAccessControlListInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
@@ -167,9 +160,11 @@ module Twilio
               ##
               # Initialize the IpAccessControlListContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] sid The ip-access-control-list Sid that uniquely identifies this
-              #   resource
+              # @param [String] account_sid The unique id of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this
+              #   resource.
+              # @param [String] sid A 34 character string that uniquely identifies the resource
+              #   to fetch.
               # @return [IpAccessControlListContext] IpAccessControlListContext
               def initialize(version, account_sid, sid)
                 super(version)
@@ -183,16 +178,10 @@ module Twilio
               end
 
               ##
-              # Fetch a IpAccessControlListInstance
+              # Fetch the IpAccessControlListInstance
               # @return [IpAccessControlListInstance] Fetched IpAccessControlListInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 IpAccessControlListInstance.new(
                     @version,
@@ -210,11 +199,7 @@ module Twilio
               def update(friendly_name: nil)
                 data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 IpAccessControlListInstance.new(
                     @version,
@@ -225,10 +210,10 @@ module Twilio
               end
 
               ##
-              # Deletes the IpAccessControlListInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the IpAccessControlListInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -259,6 +244,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Api.V2010.IpAccessControlListContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.IpAccessControlListContext #{context}>"
+              end
             end
 
             class IpAccessControlListInstance < InstanceResource
@@ -268,8 +260,8 @@ module Twilio
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] account_sid A 34 character string that uniquely identifies this
               #   resource.
-              # @param [String] sid The ip-access-control-list Sid that uniquely identifies this
-              #   resource
+              # @param [String] sid A 34 character string that uniquely identifies the resource
+              #   to fetch.
               # @return [IpAccessControlListInstance] IpAccessControlListInstance
               def initialize(version, payload, account_sid: nil, sid: nil)
                 super(version)
@@ -332,7 +324,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The subresource_uris
+              # @return [String] The IP addresses associated with this resource.
               def subresource_uris
                 @properties['subresource_uris']
               end
@@ -344,7 +336,7 @@ module Twilio
               end
 
               ##
-              # Fetch a IpAccessControlListInstance
+              # Fetch the IpAccessControlListInstance
               # @return [IpAccessControlListInstance] Fetched IpAccessControlListInstance
               def fetch
                 context.fetch
@@ -360,8 +352,8 @@ module Twilio
               end
 
               ##
-              # Deletes the IpAccessControlListInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the IpAccessControlListInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end

data/lib/twilio-ruby/rest/api/v2010/account/sip.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -33,7 +33,8 @@ module Twilio
 
             ##
             # Access the domains
-            # @param [String] sid The domain sid that uniquely identifies the resource
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   SipDomain resource to fetch.
             # @return [DomainList]
             # @return [DomainContext] if sid was passed.
             def domains(sid=:unset)
@@ -56,8 +57,8 @@ module Twilio
 
             ##
             # Access the ip_access_control_lists
-            # @param [String] sid The ip-access-control-list Sid that uniquely identifies this
-            #   resource
+            # @param [String] sid A 34 character string that uniquely identifies the resource
+            #   to fetch.
             # @return [IpAccessControlListList]
             # @return [IpAccessControlListContext] if sid was passed.
             def ip_access_control_lists(sid=:unset)

data/lib/twilio-ruby/rest/api/v2010/account/token.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,8 +15,9 @@ module Twilio
             ##
             # Initialize the TokenList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique id of the
-            #   [Account](https://www.twilio.com/docs/iam/api/account) that created this Token.
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the Token
+            #   resource.
             # @return [TokenList] TokenList
             def initialize(version, account_sid: nil)
               super(version)
@@ -27,19 +28,14 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of TokenInstance records from the API.
-            # Request is executed immediately.
+            # Create the TokenInstance
             # @param [String] ttl The duration in seconds for which the generated credentials
-            #   are valid, the default value is 86400 (24 hours).
-            # @return [TokenInstance] Newly created TokenInstance
+            #   are valid. The default value is 86400 (24 hours).
+            # @return [TokenInstance] Created TokenInstance
             def create(ttl: :unset)
               data = Twilio::Values.of({'Ttl' => ttl, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               TokenInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
@@ -85,8 +81,9 @@ module Twilio
             # Initialize the TokenInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] account_sid The unique id of the
-            #   [Account](https://www.twilio.com/docs/iam/api/account) that created this Token.
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the Token
+            #   resource.
             # @return [TokenInstance] TokenInstance
             def initialize(version, payload, account_sid: nil)
               super(version)
@@ -104,25 +101,25 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique sid that identifies this account
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [Time] The date this resource was created
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this resource was last updated
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] An array representing the ephemeral credentials
+            # @return [Array[String]] An array representing the ephemeral credentials
             def ice_servers
               @properties['ice_servers']
             end
@@ -140,7 +137,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The temporary username that uniquely identifies a Token.
+            # @return [String] The temporary username that uniquely identifies a Token
             def username
               @properties['username']
             end