twilio-ruby 5.6.0 → 5.33.0

data/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,8 @@ module Twilio
             ##
             # Initialize the CredentialListList
             # @param [Version] version Version that contains the resource
-            # @param [String] trunk_sid The trunk_sid
+            # @param [String] trunk_sid The SID of the Trunk the credential list in associated
+            #   with.
             # @return [CredentialListList] CredentialListList
             def initialize(version, trunk_sid: nil)
               super(version)
@@ -26,10 +29,13 @@ module Twilio
             ##
             # Retrieve a single page of CredentialListInstance records from the API.
             # Request is executed immediately.
-            # @param [String] credential_list_sid The credential_list_sid
+            # @param [String] credential_list_sid The SID of the [Credential
+            #   List](https://www.twilio.com/docs/voice/sip/api/sip-credentiallist-resource)
+            #   that you want to associate with the trunk. Once associated, we will authenticate
+            #   access to the trunk against this list.
             # @return [CredentialListInstance] Newly created CredentialListInstance
             def create(credential_list_sid: nil)
-              data = Twilio::Values.of({'CredentialListSid' => credential_list_sid})
+              data = Twilio::Values.of({'CredentialListSid' => credential_list_sid, })
 
               payload = @version.create(
                   'POST',
@@ -37,7 +43,7 @@ module Twilio
                   data: data
               )
 
-              CredentialListInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid])
+              CredentialListInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
             end
 
             ##
@@ -69,7 +75,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
@@ -81,7 +87,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],
@@ -148,7 +154,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [CredentialListInstance] CredentialListInstance
             def get_instance(payload)
-              CredentialListInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid])
+              CredentialListInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
             end
 
             ##
@@ -162,14 +168,16 @@ module Twilio
             ##
             # Initialize the CredentialListContext
             # @param [Version] version Version that contains the resource
-            # @param [String] trunk_sid The trunk_sid
-            # @param [String] sid The sid
+            # @param [String] trunk_sid The SID of the Trunk from which to fetch the
+            #   credential list.
+            # @param [String] sid The unique string that we created to identify the
+            #   CredentialList resource to fetch.
             # @return [CredentialListContext] CredentialListContext
             def initialize(version, trunk_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {trunk_sid: trunk_sid, sid: sid}
+              @solution = {trunk_sid: trunk_sid, sid: sid, }
               @uri = "/Trunks/#{@solution[:trunk_sid]}/CredentialLists/#{@solution[:sid]}"
             end
 
@@ -185,12 +193,17 @@ module Twilio
                   params,
               )
 
-              CredentialListInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], sid: @solution[:sid])
+              CredentialListInstance.new(
+                  @version,
+                  payload,
+                  trunk_sid: @solution[:trunk_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
             # Deletes the CredentialListInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -201,6 +214,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Trunking.V1.CredentialListContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Trunking.V1.CredentialListContext #{context}>"
+            end
           end
 
           class CredentialListInstance < InstanceResource
@@ -208,8 +228,10 @@ module Twilio
             # Initialize the CredentialListInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] trunk_sid The trunk_sid
-            # @param [String] sid The sid
+            # @param [String] trunk_sid The SID of the Trunk the credential list in associated
+            #   with.
+            # @param [String] sid The unique string that we created to identify the
+            #   CredentialList resource to fetch.
             # @return [CredentialListInstance] CredentialListInstance
             def initialize(version, payload, trunk_sid: nil, sid: nil)
               super(version)
@@ -227,7 +249,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'trunk_sid' => trunk_sid, 'sid' => sid || @properties['sid']}
+              @params = {'trunk_sid' => trunk_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -236,49 +258,49 @@ module Twilio
             # @return [CredentialListContext] CredentialListContext for this CredentialListInstance
             def context
               unless @instance_context
-                @instance_context = CredentialListContext.new(@version, @params['trunk_sid'], @params['sid'])
+                @instance_context = CredentialListContext.new(@version, @params['trunk_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The trunk_sid
+            # @return [String] The SID of the Trunk the credential list in associated with
             def trunk_sid
               @properties['trunk_sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
@@ -292,7 +314,7 @@ module Twilio
 
             ##
             # Deletes the CredentialListInstance
-            # @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/trunking/v1/trunk/ip_access_control_list.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,7 @@ module Twilio
             ##
             # Initialize the IpAccessControlListList
             # @param [Version] version Version that contains the resource
-            # @param [String] trunk_sid The trunk_sid
+            # @param [String] trunk_sid The SID of the Trunk the resource is associated with.
             # @return [IpAccessControlListList] IpAccessControlListList
             def initialize(version, trunk_sid: nil)
               super(version)
@@ -26,10 +28,11 @@ module Twilio
             ##
             # Retrieve a single page of IpAccessControlListInstance records from the API.
             # Request is executed immediately.
-            # @param [String] ip_access_control_list_sid The ip_access_control_list_sid
+            # @param [String] ip_access_control_list_sid The SID of the [IP Access Control
+            #   List](https://www.twilio.com/docs/voice/sip/api/sip-ipaccesscontrollist-resource) that you want to associate with the trunk.
             # @return [IpAccessControlListInstance] Newly created IpAccessControlListInstance
             def create(ip_access_control_list_sid: nil)
-              data = Twilio::Values.of({'IpAccessControlListSid' => ip_access_control_list_sid})
+              data = Twilio::Values.of({'IpAccessControlListSid' => ip_access_control_list_sid, })
 
               payload = @version.create(
                   'POST',
@@ -37,7 +40,7 @@ module Twilio
                   data: data
               )
 
-              IpAccessControlListInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid])
+              IpAccessControlListInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
             end
 
             ##
@@ -69,7 +72,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
@@ -81,7 +84,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],
@@ -148,7 +151,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [IpAccessControlListInstance] IpAccessControlListInstance
             def get_instance(payload)
-              IpAccessControlListInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid])
+              IpAccessControlListInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
             end
 
             ##
@@ -162,14 +165,16 @@ module Twilio
             ##
             # Initialize the IpAccessControlListContext
             # @param [Version] version Version that contains the resource
-            # @param [String] trunk_sid The trunk_sid
-            # @param [String] sid The sid
+            # @param [String] trunk_sid The SID of the Trunk from which to fetch the IP Access
+            #   Control List.
+            # @param [String] sid The unique string that we created to identify the
+            #   IpAccessControlList resource to fetch.
             # @return [IpAccessControlListContext] IpAccessControlListContext
             def initialize(version, trunk_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {trunk_sid: trunk_sid, sid: sid}
+              @solution = {trunk_sid: trunk_sid, sid: sid, }
               @uri = "/Trunks/#{@solution[:trunk_sid]}/IpAccessControlLists/#{@solution[:sid]}"
             end
 
@@ -195,7 +200,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
@@ -206,6 +211,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Trunking.V1.IpAccessControlListContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Trunking.V1.IpAccessControlListContext #{context}>"
+            end
           end
 
           class IpAccessControlListInstance < InstanceResource
@@ -213,8 +225,9 @@ module Twilio
             # Initialize the IpAccessControlListInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] trunk_sid The trunk_sid
-            # @param [String] sid The sid
+            # @param [String] trunk_sid The SID of the Trunk the resource is associated with.
+            # @param [String] sid The unique string that we created to identify the
+            #   IpAccessControlList resource to fetch.
             # @return [IpAccessControlListInstance] IpAccessControlListInstance
             def initialize(version, payload, trunk_sid: nil, sid: nil)
               super(version)
@@ -232,7 +245,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'trunk_sid' => trunk_sid, 'sid' => sid || @properties['sid']}
+              @params = {'trunk_sid' => trunk_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -241,49 +254,49 @@ module Twilio
             # @return [IpAccessControlListContext] IpAccessControlListContext for this IpAccessControlListInstance
             def context
               unless @instance_context
-                @instance_context = IpAccessControlListContext.new(@version, @params['trunk_sid'], @params['sid'])
+                @instance_context = IpAccessControlListContext.new(@version, @params['trunk_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The trunk_sid
+            # @return [String] The SID of the Trunk the resource is associated with
             def trunk_sid
               @properties['trunk_sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
@@ -297,7 +310,7 @@ module Twilio
 
             ##
             # Deletes the IpAccessControlListInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end