twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,8 +15,9 @@ module Twilio
             ##
             # Initialize the OutgoingCallerIdList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique id of the Account responsible for this
-            #   Caller Id.
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+            #   OutgoingCallerId resource.
             # @return [OutgoingCallerIdList] OutgoingCallerIdList
             def initialize(version, account_sid: nil)
               super(version)
@@ -28,10 +31,10 @@ module Twilio
             # Lists OutgoingCallerIdInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] phone_number Only show the caller id resource that exactly
-            #   matches this phone number
-            # @param [String] friendly_name Only show the caller id resource that exactly
-            #   matches this name
+            # @param [String] phone_number The phone number of the OutgoingCallerId resources
+            #   to read.
+            # @param [String] friendly_name The string that identifies the OutgoingCallerId
+            #   resources to read.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit.  Default is no limit
             # @param [Integer] page_size Number of records to fetch per request, when
@@ -52,10 +55,10 @@ module Twilio
             # Streams OutgoingCallerIdInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] phone_number Only show the caller id resource that exactly
-            #   matches this phone number
-            # @param [String] friendly_name Only show the caller id resource that exactly
-            #   matches this name
+            # @param [String] phone_number The phone number of the OutgoingCallerId resources
+            #   to read.
+            # @param [String] friendly_name The string that identifies the OutgoingCallerId
+            #   resources to read.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit. Default is no limit.
             # @param [Integer] page_size Number of records to fetch per request, when
@@ -82,7 +85,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],
@@ -92,10 +95,10 @@ module Twilio
             ##
             # Retrieve a single page of OutgoingCallerIdInstance records from the API.
             # Request is executed immediately.
-            # @param [String] phone_number Only show the caller id resource that exactly
-            #   matches this phone number
-            # @param [String] friendly_name Only show the caller id resource that exactly
-            #   matches this name
+            # @param [String] phone_number The phone number of the OutgoingCallerId resources
+            #   to read.
+            # @param [String] friendly_name The string that identifies the OutgoingCallerId
+            #   resources to read.
             # @param [String] page_token PageToken provided by the API
             # @param [Integer] page_number Page Number, this value is simply for client state
             # @param [Integer] page_size Number of records to return, defaults to 50
@@ -108,11 +111,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               OutgoingCallerIdPage.new(@version, response, @solution)
             end
 
@@ -155,7 +156,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [OutgoingCallerIdInstance] OutgoingCallerIdInstance
             def get_instance(payload)
-              OutgoingCallerIdInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              OutgoingCallerIdInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -169,29 +170,25 @@ module Twilio
             ##
             # Initialize the OutgoingCallerIdContext
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The outgoing-caller-id 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
+            #   OutgoingCallerId resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   OutgoingCallerId resource to fetch.
             # @return [OutgoingCallerIdContext] OutgoingCallerIdContext
             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]}/OutgoingCallerIds/#{@solution[:sid]}.json"
             end
 
             ##
-            # Fetch a OutgoingCallerIdInstance
+            # Fetch the OutgoingCallerIdInstance
             # @return [OutgoingCallerIdInstance] Fetched OutgoingCallerIdInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               OutgoingCallerIdInstance.new(
                   @version,
@@ -203,16 +200,13 @@ module Twilio
 
             ##
             # Update the OutgoingCallerIdInstance
-            # @param [String] friendly_name A human readable description of the caller ID
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [OutgoingCallerIdInstance] Updated OutgoingCallerIdInstance
             def update(friendly_name: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name})
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               OutgoingCallerIdInstance.new(
                   @version,
@@ -223,10 +217,10 @@ module Twilio
             end
 
             ##
-            # Deletes the OutgoingCallerIdInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the OutgoingCallerIdInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -235,6 +229,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.OutgoingCallerIdContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.OutgoingCallerIdContext #{context}>"
+            end
           end
 
           class OutgoingCallerIdInstance < InstanceResource
@@ -242,10 +243,11 @@ module Twilio
             # Initialize the OutgoingCallerIdInstance
             # @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
-            #   Caller Id.
-            # @param [String] sid The outgoing-caller-id 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
+            #   OutgoingCallerId resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   OutgoingCallerId resource to fetch.
             # @return [OutgoingCallerIdInstance] OutgoingCallerIdInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
               super(version)
@@ -263,7 +265,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
 
             ##
@@ -272,55 +274,55 @@ module Twilio
             # @return [OutgoingCallerIdContext] OutgoingCallerIdContext for this OutgoingCallerIdInstance
             def context
               unless @instance_context
-                @instance_context = OutgoingCallerIdContext.new(@version, @params['account_sid'], @params['sid'])
+                @instance_context = OutgoingCallerIdContext.new(@version, @params['account_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] A string that uniquely identifies this outgoing-caller-ids
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['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 [String] A human readable description for this resource
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             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] The incoming phone number
+            # @return [String] The phone number in E.164 format
             def phone_number
               @properties['phone_number']
             end
 
             ##
-            # @return [String] The URI for this resource
+            # @return [String] The URI of the resource, relative to `https://api.twilio.com`
             def uri
               @properties['uri']
             end
 
             ##
-            # Fetch a OutgoingCallerIdInstance
+            # Fetch the OutgoingCallerIdInstance
             # @return [OutgoingCallerIdInstance] Fetched OutgoingCallerIdInstance
             def fetch
               context.fetch
@@ -328,15 +330,16 @@ module Twilio
 
             ##
             # Update the OutgoingCallerIdInstance
-            # @param [String] friendly_name A human readable description of the caller ID
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [OutgoingCallerIdInstance] Updated OutgoingCallerIdInstance
             def update(friendly_name: :unset)
-              context.update(friendly_name: friendly_name)
+              context.update(friendly_name: friendly_name, )
             end
 
             ##
-            # Deletes the OutgoingCallerIdInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the OutgoingCallerIdInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,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)
@@ -55,7 +58,7 @@ module Twilio
               def stream(limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -67,7 +70,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],
@@ -87,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
 
@@ -153,29 +154,28 @@ 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)
 
                 # Path Solution
-                @solution = {account_sid: account_sid, queue_sid: queue_sid, call_sid: call_sid}
+                @solution = {account_sid: account_sid, queue_sid: queue_sid, call_sid: call_sid, }
                 @uri = "/Accounts/#{@solution[:account_sid]}/Queues/#{@solution[:queue_sid]}/Members/#{@solution[:call_sid]}.json"
               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,
@@ -188,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)
-                data = Twilio::Values.of({'Url' => url, 'Method' => method})
+              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,
@@ -215,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
@@ -222,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)
@@ -237,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
@@ -265,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
@@ -283,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
@@ -295,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
@@ -303,11 +318,13 @@ 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)
-                context.update(url: url, method: method)
+              def update(url: nil, method: :unset)
+                context.update(url: url, method: method, )
               end
 
               ##