twilio-ruby 5.6.0 → 5.33.1

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,9 @@ module Twilio
             ##
             # Initialize the QueueList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that created this Queue
+            #   resource.
             # @return [QueueList] QueueList
             def initialize(version, account_sid: nil)
               super(version)
@@ -52,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
@@ -64,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],
@@ -108,12 +112,13 @@ module Twilio
             ##
             # Retrieve a single page of QueueInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name A user-provided string that identifies this queue.
-            # @param [String] max_size The upper limit of calls allowed to be in the queue.
-            #   The default is 100. The maximum is 1000.
+            # @param [String] friendly_name A descriptive string that you created to describe
+            #   this resource. It can be up to 64 characters long.
+            # @param [String] max_size The maximum number of calls allowed to be in the queue.
+            #   The default is 100. The maximum is 5000.
             # @return [QueueInstance] Newly created QueueInstance
             def create(friendly_name: nil, max_size: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name, 'MaxSize' => max_size})
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, 'MaxSize' => max_size, })
 
               payload = @version.create(
                   'POST',
@@ -121,7 +126,7 @@ module Twilio
                   data: data
               )
 
-              QueueInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              QueueInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -150,7 +155,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [QueueInstance] QueueInstance
             def get_instance(payload)
-              QueueInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              QueueInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -164,14 +169,17 @@ module Twilio
             ##
             # Initialize the QueueContext
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The queue Sid that uniquely identifies this resource
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue
+            #   resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Queue resource to fetch
             # @return [QueueContext] QueueContext
             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]}/Queues/#{@solution[:sid]}.json"
 
               # Dependents
@@ -190,17 +198,18 @@ module Twilio
                   params,
               )
 
-              QueueInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              QueueInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
             end
 
             ##
             # Update the QueueInstance
-            # @param [String] friendly_name A human readable description of the queue
-            # @param [String] max_size The maximum number of members that can be in the queue
-            #   at a time
+            # @param [String] friendly_name A descriptive string that you created to describe
+            #   this resource. It can be up to 64 characters long.
+            # @param [String] max_size The maximum number of calls allowed to be in the queue.
+            #   The default is 100. The maximum is 5000.
             # @return [QueueInstance] Updated QueueInstance
             def update(friendly_name: :unset, max_size: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name, 'MaxSize' => max_size})
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, 'MaxSize' => max_size, })
 
               payload = @version.update(
                   'POST',
@@ -208,12 +217,12 @@ module Twilio
                   data: data,
               )
 
-              QueueInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              QueueInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
             end
 
             ##
             # Deletes the QueueInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -226,11 +235,15 @@ module Twilio
               raise ArgumentError, 'call_sid cannot be nil' if call_sid.nil?
 
               if call_sid != :unset
-                return MemberContext.new(@version, @solution[:account_sid], @solution[:sid], call_sid)
+                return MemberContext.new(@version, @solution[:account_sid], @solution[:sid], call_sid, )
               end
 
               unless @members
-                @members = MemberList.new(@version, account_sid: @solution[:account_sid], queue_sid: @solution[:sid])
+                @members = MemberList.new(
+                    @version,
+                    account_sid: @solution[:account_sid],
+                    queue_sid: @solution[:sid],
+                )
               end
 
               @members
@@ -242,6 +255,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.QueueContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.QueueContext #{context}>"
+            end
           end
 
           class QueueInstance < InstanceResource
@@ -249,8 +269,11 @@ module Twilio
             # Initialize the QueueInstance
             # @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] sid The queue Sid that uniquely identifies this resource
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that created this Queue
+            #   resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Queue resource to fetch
             # @return [QueueInstance] QueueInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
               super(version)
@@ -270,7 +293,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
 
             ##
@@ -279,13 +302,13 @@ module Twilio
             # @return [QueueContext] QueueContext for this QueueInstance
             def context
               unless @instance_context
-                @instance_context = QueueContext.new(@version, @params['account_sid'], @params['sid'])
+                @instance_context = QueueContext.new(@version, @params['account_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created this resource
             def account_sid
               @properties['account_sid']
             end
@@ -297,25 +320,25 @@ module Twilio
             end
 
             ##
-            # @return [String] The count of calls currently in the queue.
+            # @return [String] The number of calls currently in the queue.
             def current_size
               @properties['current_size']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 date and time in GMT that this 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 that this resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] A user-provided string that identifies this queue.
+            # @return [String] A string that you assigned to describe this resource
             def friendly_name
               @properties['friendly_name']
             end
@@ -327,13 +350,13 @@ module Twilio
             end
 
             ##
-            # @return [String] A string that uniquely identifies this queue
+            # @return [String] The unique string that identifies this resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The uri
+            # @return [String] The URI of this resource, relative to `https://api.twilio.com`
             def uri
               @properties['uri']
             end
@@ -347,17 +370,18 @@ module Twilio
 
             ##
             # Update the QueueInstance
-            # @param [String] friendly_name A human readable description of the queue
-            # @param [String] max_size The maximum number of members that can be in the queue
-            #   at a time
+            # @param [String] friendly_name A descriptive string that you created to describe
+            #   this resource. It can be up to 64 characters long.
+            # @param [String] max_size The maximum number of calls allowed to be in the queue.
+            #   The default is 100. The maximum is 5000.
             # @return [QueueInstance] Updated QueueInstance
             def update(friendly_name: :unset, max_size: :unset)
-              context.update(friendly_name: friendly_name, max_size: max_size)
+              context.update(friendly_name: friendly_name, max_size: max_size, )
             end
 
             ##
             # Deletes the QueueInstance
-            # @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/recording/add_on_result/payload.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,12 +17,13 @@ module Twilio
                 ##
                 # Initialize the PayloadList
                 # @param [Version] version Version that contains the resource
-                # @param [String] account_sid The unique id of the Account responsible for the
-                #   recording.
-                # @param [String] reference_sid A 34 character string that uniquely identifies the
-                #   recording to which this payload belongs.
-                # @param [String] add_on_result_sid A 34 character string that uniquely identifies
-                #   this result to which this payload belongs.
+                # @param [String] account_sid The SID of the
+                #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+                #   Recording AddOnResult Payload resource.
+                # @param [String] reference_sid The SID of the recording to which the AddOnResult
+                #   resource that contains the payload belongs.
+                # @param [String] add_on_result_sid The SID of the AddOnResult to which the
+                #   payload belongs.
                 # @return [PayloadList] PayloadList
                 def initialize(version, account_sid: nil, reference_sid: nil, add_on_result_sid: nil)
                   super(version)
@@ -63,7 +66,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
@@ -75,7 +78,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],
@@ -162,10 +165,15 @@ module Twilio
                 ##
                 # Initialize the PayloadContext
                 # @param [Version] version Version that contains the resource
-                # @param [String] account_sid The account_sid
-                # @param [String] reference_sid The reference_sid
-                # @param [String] add_on_result_sid The add_on_result_sid
-                # @param [String] sid The paylod Sid that uniquely identifies this resource
+                # @param [String] account_sid The SID of the
+                #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+                #   Recording AddOnResult Payload resource to fetch.
+                # @param [String] reference_sid The SID of the recording to which the AddOnResult
+                #   resource that contains the payload to fetch belongs.
+                # @param [String] add_on_result_sid The SID of the AddOnResult to which the
+                #   payload to fetch belongs.
+                # @param [String] sid The Twilio-provided string that uniquely identifies the
+                #   Recording AddOnResult Payload resource to fetch.
                 # @return [PayloadContext] PayloadContext
                 def initialize(version, account_sid, reference_sid, add_on_result_sid, sid)
                   super(version)
@@ -204,7 +212,7 @@ module Twilio
 
                 ##
                 # Deletes the PayloadInstance
-                # @return [Boolean] true if delete succeeds, true otherwise
+                # @return [Boolean] true if delete succeeds, false otherwise
                 def delete
                   @version.delete('delete', @uri)
                 end
@@ -215,6 +223,13 @@ module Twilio
                   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                   "#<Twilio.Api.V2010.PayloadContext #{context}>"
                 end
+
+                ##
+                # Provide a detailed, user friendly representation
+                def inspect
+                  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                  "#<Twilio.Api.V2010.PayloadContext #{context}>"
+                end
               end
 
               class PayloadInstance < InstanceResource
@@ -222,13 +237,15 @@ module Twilio
                 # Initialize the PayloadInstance
                 # @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 responsible for the
-                #   recording.
-                # @param [String] reference_sid A 34 character string that uniquely identifies the
-                #   recording to which this payload belongs.
-                # @param [String] add_on_result_sid A 34 character string that uniquely identifies
-                #   this result to which this payload belongs.
-                # @param [String] sid The paylod Sid that uniquely identifies this resource
+                # @param [String] account_sid The SID of the
+                #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+                #   Recording AddOnResult Payload resource.
+                # @param [String] reference_sid The SID of the recording to which the AddOnResult
+                #   resource that contains the payload belongs.
+                # @param [String] add_on_result_sid The SID of the AddOnResult to which the
+                #   payload belongs.
+                # @param [String] sid The Twilio-provided string that uniquely identifies the
+                #   Recording AddOnResult Payload resource to fetch.
                 # @return [PayloadInstance] PayloadInstance
                 def initialize(version, payload, account_sid: nil, reference_sid: nil, add_on_result_sid: nil, sid: nil)
                   super(version)
@@ -276,67 +293,67 @@ module Twilio
                 end
 
                 ##
-                # @return [String] A string that uniquely identifies this payload
+                # @return [String] The unique string that identifies the resource
                 def sid
                   @properties['sid']
                 end
 
                 ##
-                # @return [String] A string that uniquely identifies the result
+                # @return [String] The SID of the AddOnResult to which the payload belongs
                 def add_on_result_sid
                   @properties['add_on_result_sid']
                 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 [String] A string that describes the payload.
+                # @return [String] The string that describes the payload
                 def label
                   @properties['label']
                 end
 
                 ##
-                # @return [String] A string that uniquely identifies the Add-on.
+                # @return [String] The SID of the Add-on to which the result belongs
                 def add_on_sid
                   @properties['add_on_sid']
                 end
 
                 ##
-                # @return [String] A string that uniquely identifies the Add-on configuration.
+                # @return [String] The SID of the Add-on configuration
                 def add_on_configuration_sid
                   @properties['add_on_configuration_sid']
                 end
 
                 ##
-                # @return [String] The MIME type of the payload.
+                # @return [String] The MIME type of the payload
                 def content_type
                   @properties['content_type']
                 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] A string that uniquely identifies the recording.
+                # @return [String] The SID of the recording to which the AddOnResult resource that contains the payload belongs
                 def reference_sid
                   @properties['reference_sid']
                 end
 
                 ##
-                # @return [String] The subresource_uris
+                # @return [String] A list of related resources identified by their relative URIs
                 def subresource_uris
                   @properties['subresource_uris']
                 end
@@ -350,7 +367,7 @@ module Twilio
 
                 ##
                 # Deletes the PayloadInstance
-                # @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/recording/add_on_result.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,10 +16,11 @@ module Twilio
               ##
               # Initialize the AddOnResultList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The unique id of the Account responsible for this
-              #   recording.
-              # @param [String] reference_sid A 34 character string that uniquely identifies the
-              #   recording to which this result belongs.
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+              #   Recording AddOnResult resource.
+              # @param [String] reference_sid The SID of the recording to which the AddOnResult
+              #   resource belongs.
               # @return [AddOnResultList] AddOnResultList
               def initialize(version, account_sid: nil, reference_sid: nil)
                 super(version)
@@ -56,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
@@ -68,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],
@@ -154,15 +157,19 @@ module Twilio
               ##
               # Initialize the AddOnResultContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] reference_sid The reference_sid
-              # @param [String] sid The result Sid that uniquely identifies this resource
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+              #   Recording AddOnResult resource to fetch.
+              # @param [String] reference_sid The SID of the recording to which the result to
+              #   fetch belongs.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Recording AddOnResult resource to fetch.
               # @return [AddOnResultContext] AddOnResultContext
               def initialize(version, account_sid, reference_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {account_sid: account_sid, reference_sid: reference_sid, sid: sid}
+                @solution = {account_sid: account_sid, reference_sid: reference_sid, sid: sid, }
                 @uri = "/Accounts/#{@solution[:account_sid]}/Recordings/#{@solution[:reference_sid]}/AddOnResults/#{@solution[:sid]}.json"
 
                 # Dependents
@@ -192,7 +199,7 @@ module Twilio
 
               ##
               # Deletes the AddOnResultInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
@@ -232,6 +239,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Api.V2010.AddOnResultContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.AddOnResultContext #{context}>"
+              end
             end
 
             class AddOnResultInstance < InstanceResource
@@ -239,11 +253,13 @@ module Twilio
               # Initialize the AddOnResultInstance
               # @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 responsible for this
-              #   recording.
-              # @param [String] reference_sid A 34 character string that uniquely identifies the
-              #   recording to which this result belongs.
-              # @param [String] sid The result Sid that uniquely identifies this resource
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+              #   Recording AddOnResult resource.
+              # @param [String] reference_sid The SID of the recording to which the AddOnResult
+              #   resource belongs.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Recording AddOnResult resource to fetch.
               # @return [AddOnResultInstance] AddOnResultInstance
               def initialize(version, payload, account_sid: nil, reference_sid: nil, sid: nil)
                 super(version)
@@ -288,61 +304,61 @@ module Twilio
               end
 
               ##
-              # @return [String] A string that uniquely identifies this result
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               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 [add_on_result.Status] The status of this result.
+              # @return [add_on_result.Status] The status of the result
               def status
                 @properties['status']
               end
 
               ##
-              # @return [String] A string that uniquely identifies the Add-on.
+              # @return [String] The SID of the Add-on to which the result belongs
               def add_on_sid
                 @properties['add_on_sid']
               end
 
               ##
-              # @return [String] A string that uniquely identifies the Add-on configuration.
+              # @return [String] The SID of the Add-on configuration
               def add_on_configuration_sid
                 @properties['add_on_configuration_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 [Time] The date this result was completed.
+              # @return [Time] The date and time in GMT that the result was completed
               def date_completed
                 @properties['date_completed']
               end
 
               ##
-              # @return [String] A string that uniquely identifies the recording.
+              # @return [String] The SID of the recording to which the AddOnResult resource belongs
               def reference_sid
                 @properties['reference_sid']
               end
 
               ##
-              # @return [String] The subresource_uris
+              # @return [String] A list of related resources identified by their relative URIs
               def subresource_uris
                 @properties['subresource_uris']
               end
@@ -356,7 +372,7 @@ module Twilio
 
               ##
               # Deletes the AddOnResultInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end