twilio-ruby 5.5.1 → 5.58.3

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],
@@ -84,11 +88,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               QueuePage.new(@version, response, @solution)
             end
 
@@ -106,22 +108,18 @@ module Twilio
             end
 
             ##
-            # 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.
-            # @return [QueueInstance] Newly created QueueInstance
+            # Create the QueueInstance
+            # @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] 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',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              QueueInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              QueueInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -150,7 +148,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 +162,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
@@ -179,43 +180,34 @@ module Twilio
             end
 
             ##
-            # Fetch a QueueInstance
+            # Fetch the QueueInstance
             # @return [QueueInstance] Fetched QueueInstance
             def fetch
-              params = Twilio::Values.of({})
+              payload = @version.fetch('GET', @uri)
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  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',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, 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
+            # Delete the QueueInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -226,11 +218,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 +238,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,28 +252,31 @@ 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)
 
               # Marshaled Properties
               @properties = {
+                  'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                  'current_size' => payload['current_size'].to_i,
+                  'friendly_name' => payload['friendly_name'],
+                  'uri' => payload['uri'],
                   'account_sid' => payload['account_sid'],
                   'average_wait_time' => payload['average_wait_time'].to_i,
-                  'current_size' => payload['current_size'].to_i,
+                  'sid' => payload['sid'],
                   'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
-                  'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
-                  'friendly_name' => payload['friendly_name'],
                   'max_size' => payload['max_size'].to_i,
-                  'sid' => payload['sid'],
-                  'uri' => payload['uri'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid']}
+              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -279,67 +285,67 @@ 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
-            def account_sid
-              @properties['account_sid']
-            end
-
-            ##
-            # @return [String] Average wait time of members in the queue
-            def average_wait_time
-              @properties['average_wait_time']
+            # @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] 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
-            def date_created
-              @properties['date_created']
+            # @return [String] A string that you assigned to describe this resource
+            def friendly_name
+              @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The date_updated
-            def date_updated
-              @properties['date_updated']
+            # @return [String] The URI of this resource, relative to `https://api.twilio.com`
+            def uri
+              @properties['uri']
             end
 
             ##
-            # @return [String] A user-provided string that identifies this queue.
-            def friendly_name
-              @properties['friendly_name']
+            # @return [String] The SID of the Account that created this resource
+            def account_sid
+              @properties['account_sid']
             end
 
             ##
-            # @return [String] The max number of calls allowed in the queue
-            def max_size
-              @properties['max_size']
+            # @return [String] Average wait time of members in the queue
+            def average_wait_time
+              @properties['average_wait_time']
             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
-            def uri
-              @properties['uri']
+            # @return [Time] The RFC 2822 date and time in GMT that this resource was created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [String] The max number of calls allowed in the queue
+            def max_size
+              @properties['max_size']
             end
 
             ##
-            # Fetch a QueueInstance
+            # Fetch the QueueInstance
             # @return [QueueInstance] Fetched QueueInstance
             def fetch
               context.fetch
@@ -347,17 +353,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
+            # Delete the QueueInstance
+            # @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],
@@ -95,11 +98,9 @@ module Twilio
                       'Page' => page_number,
                       'PageSize' => page_size,
                   })
-                  response = @version.page(
-                      'GET',
-                      @uri,
-                      params
-                  )
+
+                  response = @version.page('GET', @uri, params: params)
+
                   PayloadPage.new(@version, response, @solution)
                 end
 
@@ -162,10 +163,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)
@@ -181,16 +187,10 @@ module Twilio
                 end
 
                 ##
-                # Fetch a PayloadInstance
+                # Fetch the PayloadInstance
                 # @return [PayloadInstance] Fetched PayloadInstance
                 def fetch
-                  params = Twilio::Values.of({})
-
-                  payload = @version.fetch(
-                      'GET',
-                      @uri,
-                      params,
-                  )
+                  payload = @version.fetch('GET', @uri)
 
                   PayloadInstance.new(
                       @version,
@@ -203,10 +203,10 @@ module Twilio
                 end
 
                 ##
-                # Deletes the PayloadInstance
-                # @return [Boolean] true if delete succeeds, true otherwise
+                # Delete the PayloadInstance
+                # @return [Boolean] true if delete succeeds, false otherwise
                 def delete
-                  @version.delete('delete', @uri)
+                   @version.delete('DELETE', @uri)
                 end
 
                 ##
@@ -215,6 +215,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 +229,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,81 +285,81 @@ 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
 
                 ##
-                # Fetch a PayloadInstance
+                # Fetch the PayloadInstance
                 # @return [PayloadInstance] Fetched PayloadInstance
                 def fetch
                   context.fetch
                 end
 
                 ##
-                # Deletes the PayloadInstance
-                # @return [Boolean] true if delete succeeds, true otherwise
+                # Delete the PayloadInstance
+                # @return [Boolean] true if delete succeeds, false otherwise
                 def delete
                   context.delete
                 end