twilio-ruby 5.6.0 → 5.33.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,8 +17,10 @@ module Twilio
                 ##
                 # Initialize the IpAddressList
                 # @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] account_sid The unique id of the Account that is responsible for
+                #   this resource.
+                # @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)
@@ -55,7 +59,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
@@ -67,7 +71,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],
@@ -111,11 +115,21 @@ module Twilio
                 ##
                 # 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] 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] Newly created IpAddressInstance
-                def create(friendly_name: nil, ip_address: nil)
-                  data = Twilio::Values.of({'FriendlyName' => friendly_name, 'IpAddress' => ip_address})
+                def create(friendly_name: nil, ip_address: nil, cidr_prefix_length: :unset)
+                  data = Twilio::Values.of({
+                      'FriendlyName' => friendly_name,
+                      'IpAddress' => ip_address,
+                      'CidrPrefixLength' => cidr_prefix_length,
+                  })
 
                   payload = @version.create(
                       'POST',
@@ -176,9 +190,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)
@@ -215,11 +233,21 @@ module Twilio
 
                 ##
                 # Update the IpAddressInstance
-                # @param [String] ip_address The ip_address
-                # @param [String] friendly_name The friendly_name
+                # @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)
-                  data = Twilio::Values.of({'IpAddress' => ip_address, 'FriendlyName' => friendly_name})
+                def update(ip_address: :unset, friendly_name: :unset, cidr_prefix_length: :unset)
+                  data = Twilio::Values.of({
+                      'IpAddress' => ip_address,
+                      'FriendlyName' => friendly_name,
+                      'CidrPrefixLength' => cidr_prefix_length,
+                  })
 
                   payload = @version.update(
                       'POST',
@@ -238,7 +266,7 @@ module Twilio
 
                 ##
                 # Deletes the IpAddressInstance
-                # @return [Boolean] true if delete succeeds, true otherwise
+                # @return [Boolean] true if delete succeeds, false otherwise
                 def delete
                   @version.delete('delete', @uri)
                 end
@@ -249,6 +277,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
@@ -256,9 +291,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 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 that is responsible for
+                #   this resource.
+                # @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)
@@ -269,6 +307,7 @@ module Twilio
                       'account_sid' => payload['account_sid'],
                       'friendly_name' => payload['friendly_name'],
                       'ip_address' => payload['ip_address'],
+                      'cidr_prefix_length' => payload['cidr_prefix_length'].to_i,
                       'ip_access_control_list_sid' => payload['ip_access_control_list_sid'],
                       'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
                       'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
@@ -301,49 +340,55 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The sid
+                # @return [String] A 34 character string that uniquely identifies this resource.
                 def sid
                   @properties['sid']
                 end
 
                 ##
-                # @return [String] The account_sid
+                # @return [String] The unique id of the Account that is responsible for this resource.
                 def account_sid
                   @properties['account_sid']
                 end
 
                 ##
-                # @return [String] The friendly_name
+                # @return [String] A human readable descriptive text for this resource, up to 64 characters long.
                 def friendly_name
                   @properties['friendly_name']
                 end
 
                 ##
-                # @return [String] The ip_address
+                # @return [String] 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.
                 def ip_address
                   @properties['ip_address']
                 end
 
                 ##
-                # @return [String] The ip_access_control_list_sid
+                # @return [String] 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.
+                def cidr_prefix_length
+                  @properties['cidr_prefix_length']
+                end
+
+                ##
+                # @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
 
                 ##
-                # @return [Time] The date_created
+                # @return [Time] The date that this resource was created, given as GMT in RFC 2822 format.
                 def date_created
                   @properties['date_created']
                 end
 
                 ##
-                # @return [Time] The date_updated
+                # @return [Time] The date that this resource was last updated, given as GMT in RFC 2822 format.
                 def date_updated
                   @properties['date_updated']
                 end
 
                 ##
-                # @return [String] The uri
+                # @return [String] The URI for this resource, relative to https://api.twilio.com
                 def uri
                   @properties['uri']
                 end
@@ -357,16 +402,26 @@ module Twilio
 
                 ##
                 # Update the IpAddressInstance
-                # @param [String] ip_address The ip_address
-                # @param [String] friendly_name The friendly_name
+                # @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)
-                  context.update(ip_address: ip_address, friendly_name: friendly_name)
+                def update(ip_address: :unset, friendly_name: :unset, cidr_prefix_length: :unset)
+                  context.update(
+                      ip_address: ip_address,
+                      friendly_name: friendly_name,
+                      cidr_prefix_length: cidr_prefix_length,
+                  )
                 end
 
                 ##
                 # Deletes the IpAddressInstance
-                # @return [Boolean] true if delete succeeds, true otherwise
+                # @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,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -54,7 +56,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
@@ -66,7 +68,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],
@@ -110,11 +112,11 @@ module Twilio
               ##
               # Retrieve a single page of IpAccessControlListInstance records from the API.
               # Request is executed immediately.
-              # @param [String] friendly_name A human readable descriptive text, up to 64
-              #   characters long.
+              # @param [String] friendly_name A human readable descriptive text that describes
+              #   the IpAccessControlList, up to 64 characters long.
               # @return [IpAccessControlListInstance] Newly created IpAccessControlListInstance
               def create(friendly_name: nil)
-                data = Twilio::Values.of({'FriendlyName' => friendly_name})
+                data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
                 payload = @version.create(
                     'POST',
@@ -122,7 +124,7 @@ module Twilio
                     data: data
                 )
 
-                IpAccessControlListInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                IpAccessControlListInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -151,7 +153,7 @@ module Twilio
               # @param [Hash] payload Payload response from the API
               # @return [IpAccessControlListInstance] IpAccessControlListInstance
               def get_instance(payload)
-                IpAccessControlListInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                IpAccessControlListInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -165,15 +167,17 @@ 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)
 
                 # Path Solution
-                @solution = {account_sid: account_sid, sid: sid}
+                @solution = {account_sid: account_sid, sid: sid, }
                 @uri = "/Accounts/#{@solution[:account_sid]}/SIP/IpAccessControlLists/#{@solution[:sid]}.json"
 
                 # Dependents
@@ -206,7 +210,7 @@ module Twilio
               #   characters long.
               # @return [IpAccessControlListInstance] Updated IpAccessControlListInstance
               def update(friendly_name: nil)
-                data = Twilio::Values.of({'FriendlyName' => friendly_name})
+                data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
                 payload = @version.update(
                     'POST',
@@ -224,7 +228,7 @@ module Twilio
 
               ##
               # Deletes the IpAccessControlListInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
@@ -237,7 +241,7 @@ module Twilio
                 raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
                 if sid != :unset
-                  return IpAddressContext.new(@version, @solution[:account_sid], @solution[:sid], sid)
+                  return IpAddressContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
                 end
 
                 unless @ip_addresses
@@ -257,6 +261,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
@@ -266,8 +277,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)
@@ -285,7 +296,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid']}
+                @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
               end
 
               ##
@@ -294,7 +305,7 @@ module Twilio
               # @return [IpAccessControlListContext] IpAccessControlListContext for this IpAccessControlListInstance
               def context
                 unless @instance_context
-                  @instance_context = IpAccessControlListContext.new(@version, @params['account_sid'], @params['sid'])
+                  @instance_context = IpAccessControlListContext.new(@version, @params['account_sid'], @params['sid'], )
                 end
                 @instance_context
               end
@@ -330,7 +341,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
@@ -354,12 +365,12 @@ module Twilio
               #   characters long.
               # @return [IpAccessControlListInstance] Updated IpAccessControlListInstance
               def update(friendly_name: nil)
-                context.update(friendly_name: friendly_name)
+                context.update(friendly_name: friendly_name, )
               end
 
               ##
               # Deletes the IpAccessControlListInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -31,17 +33,18 @@ 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)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return DomainContext.new(@version, @solution[:account_sid], sid)
+                return DomainContext.new(@version, @solution[:account_sid], sid, )
               end
 
-                @domains ||= DomainList.new(@version, account_sid: @solution[:account_sid])
+                @domains ||= DomainList.new(@version, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -49,20 +52,20 @@ module Twilio
             # @return [RegionList]
             # @return [RegionContext]
             def regions
-              @regions ||= RegionList.new(@version, account_sid: @solution[:account_sid])
+              @regions ||= RegionList.new(@version, account_sid: @solution[:account_sid], )
             end
 
             ##
             # 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)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return IpAccessControlListContext.new(@version, @solution[:account_sid], sid)
+                return IpAccessControlListContext.new(@version, @solution[:account_sid], sid, )
               end
 
                 @ip_access_control_lists ||= IpAccessControlListList.new(
@@ -73,17 +76,18 @@ module Twilio
 
             ##
             # Access the credential_lists
-            # @param [String] sid The credential Sid that uniquely identifies this resource
+            # @param [String] sid The credential list Sid that uniquely identifies this
+            #   resource
             # @return [CredentialListList]
             # @return [CredentialListContext] if sid was passed.
             def credential_lists(sid=:unset)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return CredentialListContext.new(@version, @solution[:account_sid], sid)
+                return CredentialListContext.new(@version, @solution[:account_sid], sid, )
               end
 
-                @credential_lists ||= CredentialListList.new(@version, account_sid: @solution[:account_sid])
+                @credential_lists ||= CredentialListList.new(@version, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -112,7 +116,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [SipInstance] SipInstance
             def get_instance(payload)
-              SipInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              SipInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,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 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)
@@ -28,10 +31,10 @@ module Twilio
             # Retrieve a single page of TokenInstance records from the API.
             # Request is executed immediately.
             # @param [String] ttl The duration in seconds for which the generated credentials
-            #   are valid
+            #   are valid. The default value is 86400 (24 hours).
             # @return [TokenInstance] Newly created TokenInstance
             def create(ttl: :unset)
-              data = Twilio::Values.of({'Ttl' => ttl})
+              data = Twilio::Values.of({'Ttl' => ttl, })
 
               payload = @version.create(
                   'POST',
@@ -39,7 +42,7 @@ module Twilio
                   data: data
               )
 
-              TokenInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              TokenInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -68,7 +71,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [TokenInstance] TokenInstance
             def get_instance(payload)
-              TokenInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              TokenInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -83,8 +86,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 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)
@@ -102,19 +106,19 @@ 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
@@ -138,7 +142,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