twilio-ruby 5.15.1 → 5.58.1

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,9 +16,10 @@ module Twilio
               ##
               # Initialize the MemberList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] queue_sid A 34 character string that uniquely identifies this
-              #   queue.
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Queue
+              #   resource.
+              # @param [String] queue_sid The SID of the Queue the member is in.
               # @return [MemberList] MemberList
               def initialize(version, account_sid: nil, queue_sid: nil)
                 super(version)
@@ -89,11 +90,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 MemberPage.new(@version, response, @solution)
               end
 
@@ -155,9 +154,14 @@ module Twilio
               ##
               # Initialize the MemberContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] queue_sid The Queue in which to find the members
-              # @param [String] call_sid The call_sid
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the Member
+              #   resource(s) to fetch.
+              # @param [String] queue_sid The SID of the Queue in which to find the members to
+              #   fetch.
+              # @param [String] call_sid The
+              #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the
+              #   resource(s) to fetch.
               # @return [MemberContext] MemberContext
               def initialize(version, account_sid, queue_sid, call_sid)
                 super(version)
@@ -168,16 +172,10 @@ module Twilio
               end
 
               ##
-              # Fetch a MemberInstance
+              # Fetch the MemberInstance
               # @return [MemberInstance] Fetched MemberInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 MemberInstance.new(
                     @version,
@@ -190,17 +188,15 @@ module Twilio
 
               ##
               # Update the MemberInstance
-              # @param [String] url The url
-              # @param [String] method The method
+              # @param [String] url The absolute URL of the Queue resource.
+              # @param [String] method How to pass the update request data. Can be `GET` or
+              #   `POST` and the default is `POST`. `POST` sends the data as encoded form data and
+              #   `GET` sends the data as query parameters.
               # @return [MemberInstance] Updated MemberInstance
-              def update(url: nil, method: nil)
+              def update(url: nil, method: :unset)
                 data = Twilio::Values.of({'Url' => url, 'Method' => method, })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 MemberInstance.new(
                     @version,
@@ -217,6 +213,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Api.V2010.MemberContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.MemberContext #{context}>"
+              end
             end
 
             class MemberInstance < InstanceResource
@@ -224,10 +227,13 @@ module Twilio
               # Initialize the MemberInstance
               # @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] queue_sid A 34 character string that uniquely identifies this
-              #   queue.
-              # @param [String] call_sid The call_sid
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Queue
+              #   resource.
+              # @param [String] queue_sid The SID of the Queue the member is in.
+              # @param [String] call_sid The
+              #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the
+              #   resource(s) to fetch.
               # @return [MemberInstance] MemberInstance
               def initialize(version, payload, account_sid: nil, queue_sid: nil, call_sid: nil)
                 super(version)
@@ -239,6 +245,7 @@ module Twilio
                     'position' => payload['position'].to_i,
                     'uri' => payload['uri'],
                     'wait_time' => payload['wait_time'].to_i,
+                    'queue_sid' => payload['queue_sid'],
                 }
 
                 # Context
@@ -267,7 +274,7 @@ module Twilio
               end
 
               ##
-              # @return [String] Unique string that identifies this resource
+              # @return [String] The SID of the Call the resource is associated with
               def call_sid
                 @properties['call_sid']
               end
@@ -285,7 +292,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The uri
+              # @return [String] The URI of the resource, relative to `https://api.twilio.com`
               def uri
                 @properties['uri']
               end
@@ -297,7 +304,13 @@ module Twilio
               end
 
               ##
-              # Fetch a MemberInstance
+              # @return [String] The SID of the Queue the member is in
+              def queue_sid
+                @properties['queue_sid']
+              end
+
+              ##
+              # Fetch the MemberInstance
               # @return [MemberInstance] Fetched MemberInstance
               def fetch
                 context.fetch
@@ -305,10 +318,12 @@ module Twilio
 
               ##
               # Update the MemberInstance
-              # @param [String] url The url
-              # @param [String] method The method
+              # @param [String] url The absolute URL of the Queue resource.
+              # @param [String] method How to pass the update request data. Can be `GET` or
+              #   `POST` and the default is `POST`. `POST` sends the data as encoded form data and
+              #   `GET` sends the data as query parameters.
               # @return [MemberInstance] Updated MemberInstance
-              def update(url: nil, method: nil)
+              def update(url: nil, method: :unset)
                 context.update(url: url, method: method, )
               end
 

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,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)
@@ -86,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
 
@@ -108,20 +108,16 @@ 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, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               QueueInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
@@ -166,8 +162,11 @@ 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)
@@ -181,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,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               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, })
 
-              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], )
             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
 
             ##
@@ -248,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
@@ -255,23 +252,26 @@ 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
@@ -291,61 +291,61 @@ module Twilio
             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
@@ -353,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, )
             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