twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,10 @@ module Twilio
               ##
               # Initialize the FeedbackList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] call_sid A 34 character string that uniquely identifies this
+              # @param [String] account_sid The unique id of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this
+              #   resource.
+              # @param [String] call_sid The unique string that we created to identify this Call
               #   resource.
               # @return [FeedbackList] FeedbackList
               def initialize(version, account_sid: nil, call_sid: nil)
@@ -70,34 +74,24 @@ module Twilio
               ##
               # Initialize the FeedbackContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
+              # @param [String] account_sid The unique id of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this
+              #   resource.
               # @param [String] call_sid The call sid that uniquely identifies the call
               # @return [FeedbackContext] FeedbackContext
               def initialize(version, account_sid, call_sid)
                 super(version)
 
                 # Path Solution
-                @solution = {account_sid: account_sid, call_sid: call_sid}
+                @solution = {account_sid: account_sid, call_sid: call_sid, }
                 @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Feedback.json"
               end
 
               ##
-              # Retrieve a single page of FeedbackInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] quality_score The quality_score
-              # @param [feedback.Issues] issue The issue
-              # @return [FeedbackInstance] Newly created FeedbackInstance
-              def create(quality_score: nil, issue: :unset)
-                data = Twilio::Values.of({
-                    'QualityScore' => quality_score,
-                    'Issue' => Twilio.serialize_list(issue) { |e| e },
-                })
-
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+              # Fetch the FeedbackInstance
+              # @return [FeedbackInstance] Fetched FeedbackInstance
+              def fetch
+                payload = @version.fetch('GET', @uri)
 
                 FeedbackInstance.new(
                     @version,
@@ -108,16 +102,22 @@ module Twilio
               end
 
               ##
-              # Fetch a FeedbackInstance
-              # @return [FeedbackInstance] Fetched FeedbackInstance
-              def fetch
-                params = Twilio::Values.of({})
+              # Create the FeedbackInstance
+              # @param [String] quality_score The call quality expressed as an integer from `1`
+              #   to `5` where `1` represents very poor call quality and `5` represents a perfect
+              #   call.
+              # @param [Array[feedback.Issues]] issue A list of one or more issues experienced
+              #   during the call. Issues can be: `imperfect-audio`, `dropped-call`,
+              #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
+              #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
+              # @return [FeedbackInstance] Created FeedbackInstance
+              def create(quality_score: nil, issue: :unset)
+                data = Twilio::Values.of({
+                    'QualityScore' => quality_score,
+                    'Issue' => Twilio.serialize_list(issue) { |e| e },
+                })
 
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 FeedbackInstance.new(
                     @version,
@@ -129,21 +129,21 @@ module Twilio
 
               ##
               # Update the FeedbackInstance
-              # @param [String] quality_score An integer from 1 to 5 quality score
-              # @param [feedback.Issues] issue One or more of the issues experienced during the
-              #   call
+              # @param [String] quality_score The call quality expressed as an integer from `1`
+              #   to `5` where `1` represents very poor call quality and `5` represents a perfect
+              #   call.
+              # @param [Array[feedback.Issues]] issue One or more issues experienced during the
+              #   call. The issues can be: `imperfect-audio`, `dropped-call`,
+              #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
+              #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
               # @return [FeedbackInstance] Updated FeedbackInstance
-              def update(quality_score: nil, issue: :unset)
+              def update(quality_score: :unset, issue: :unset)
                 data = Twilio::Values.of({
                     'QualityScore' => quality_score,
                     'Issue' => Twilio.serialize_list(issue) { |e| e },
                 })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 FeedbackInstance.new(
                     @version,
@@ -159,6 +159,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Api.V2010.FeedbackContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.FeedbackContext #{context}>"
+              end
             end
 
             class FeedbackInstance < InstanceResource
@@ -166,8 +173,10 @@ module Twilio
               # Initialize the FeedbackInstance
               # @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] call_sid A 34 character string that uniquely identifies this
+              # @param [String] account_sid The unique id of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this
+              #   resource.
+              # @param [String] call_sid The unique string that we created to identify this Call
               #   resource.
               # @return [FeedbackInstance] FeedbackInstance
               def initialize(version, payload, account_sid: nil, call_sid: nil)
@@ -185,7 +194,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'account_sid' => account_sid, 'call_sid' => call_sid}
+                @params = {'account_sid' => account_sid, 'call_sid' => call_sid, }
               end
 
               ##
@@ -194,31 +203,31 @@ module Twilio
               # @return [FeedbackContext] FeedbackContext for this FeedbackInstance
               def context
                 unless @instance_context
-                  @instance_context = FeedbackContext.new(@version, @params['account_sid'], @params['call_sid'])
+                  @instance_context = FeedbackContext.new(@version, @params['account_sid'], @params['call_sid'], )
                 end
                 @instance_context
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The unique sid that identifies this account
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The date this resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The date this resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [feedback.Issues] The issues
+              # @return [Array[feedback.Issues]] Issues experienced during the call
               def issues
                 @properties['issues']
               end
@@ -230,36 +239,44 @@ module Twilio
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] A string that uniquely identifies this feedback resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # Retrieve a single page of FeedbackInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] quality_score The quality_score
-              # @param [feedback.Issues] issue The issue
-              # @return [FeedbackInstance] Newly created FeedbackInstance
-              def create(quality_score: nil, issue: :unset)
-                context.create(quality_score: quality_score, issue: issue)
-              end
-
-              ##
-              # Fetch a FeedbackInstance
+              # Fetch the FeedbackInstance
               # @return [FeedbackInstance] Fetched FeedbackInstance
               def fetch
                 context.fetch
               end
 
+              ##
+              # Create the FeedbackInstance
+              # @param [String] quality_score The call quality expressed as an integer from `1`
+              #   to `5` where `1` represents very poor call quality and `5` represents a perfect
+              #   call.
+              # @param [Array[feedback.Issues]] issue A list of one or more issues experienced
+              #   during the call. Issues can be: `imperfect-audio`, `dropped-call`,
+              #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
+              #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
+              # @return [FeedbackInstance] Created FeedbackInstance
+              def create(quality_score: nil, issue: :unset)
+                context.create(quality_score: quality_score, issue: issue, )
+              end
+
               ##
               # Update the FeedbackInstance
-              # @param [String] quality_score An integer from 1 to 5 quality score
-              # @param [feedback.Issues] issue One or more of the issues experienced during the
-              #   call
+              # @param [String] quality_score The call quality expressed as an integer from `1`
+              #   to `5` where `1` represents very poor call quality and `5` represents a perfect
+              #   call.
+              # @param [Array[feedback.Issues]] issue One or more issues experienced during the
+              #   call. The issues can be: `imperfect-audio`, `dropped-call`,
+              #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
+              #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
               # @return [FeedbackInstance] Updated FeedbackInstance
-              def update(quality_score: nil, issue: :unset)
-                context.update(quality_score: quality_score, issue: issue)
+              def update(quality_score: :unset, issue: :unset)
+                context.update(quality_score: quality_score, issue: issue, )
               end
 
               ##

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,9 @@ module Twilio
               ##
               # Initialize the FeedbackSummaryList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The unique id of the Account responsible for
-              #   creating this Call
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call
+              #   resource.
               # @return [FeedbackSummaryList] FeedbackSummaryList
               def initialize(version, account_sid: nil)
                 super(version)
@@ -26,14 +29,19 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of FeedbackSummaryInstance records from the API.
-              # Request is executed immediately.
-              # @param [Date] start_date The start_date
-              # @param [Date] end_date The end_date
-              # @param [Boolean] include_subaccounts The include_subaccounts
-              # @param [String] status_callback The status_callback
-              # @param [String] status_callback_method The status_callback_method
-              # @return [FeedbackSummaryInstance] Newly created FeedbackSummaryInstance
+              # Create the FeedbackSummaryInstance
+              # @param [Date] start_date Only include feedback given on or after this date.
+              #   Format is `YYYY-MM-DD` and specified in UTC.
+              # @param [Date] end_date Only include feedback given on or before this date.
+              #   Format is `YYYY-MM-DD` and specified in UTC.
+              # @param [Boolean] include_subaccounts Whether to also include Feedback resources
+              #   from all subaccounts. `true` includes feedback from all subaccounts and `false`,
+              #   the default, includes feedback from only the specified account.
+              # @param [String] status_callback The URL that we will request when the feedback
+              #   summary is complete.
+              # @param [String] status_callback_method The HTTP method (`GET` or `POST`) we use
+              #   to make the request to the `StatusCallback` URL.
+              # @return [FeedbackSummaryInstance] Created FeedbackSummaryInstance
               def create(start_date: nil, end_date: nil, include_subaccounts: :unset, status_callback: :unset, status_callback_method: :unset)
                 data = Twilio::Values.of({
                     'StartDate' => Twilio.serialize_iso8601_date(start_date),
@@ -43,13 +51,9 @@ module Twilio
                     'StatusCallbackMethod' => status_callback_method,
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
-                FeedbackSummaryInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                FeedbackSummaryInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -78,7 +82,7 @@ module Twilio
               # @param [Hash] payload Payload response from the API
               # @return [FeedbackSummaryInstance] FeedbackSummaryInstance
               def get_instance(payload)
-                FeedbackSummaryInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                FeedbackSummaryInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -92,28 +96,25 @@ module Twilio
               ##
               # Initialize the FeedbackSummaryContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] sid The sid
+              # @param [String] account_sid The unique id of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this
+              #   resource.
+              # @param [String] sid A 34 character string that uniquely identifies this
+              #   resource.
               # @return [FeedbackSummaryContext] FeedbackSummaryContext
               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]}/Calls/FeedbackSummary/#{@solution[:sid]}.json"
               end
 
               ##
-              # Fetch a FeedbackSummaryInstance
+              # Fetch the FeedbackSummaryInstance
               # @return [FeedbackSummaryInstance] Fetched FeedbackSummaryInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 FeedbackSummaryInstance.new(
                     @version,
@@ -124,10 +125,10 @@ module Twilio
               end
 
               ##
-              # Deletes the FeedbackSummaryInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the FeedbackSummaryInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -136,6 +137,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Api.V2010.FeedbackSummaryContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.FeedbackSummaryContext #{context}>"
+              end
             end
 
             class FeedbackSummaryInstance < InstanceResource
@@ -143,9 +151,11 @@ module Twilio
               # Initialize the FeedbackSummaryInstance
               # @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
-              #   creating this Call
-              # @param [String] sid The sid
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call
+              #   resource.
+              # @param [String] sid A 34 character string that uniquely identifies this
+              #   resource.
               # @return [FeedbackSummaryInstance] FeedbackSummaryInstance
               def initialize(version, payload, account_sid: nil, sid: nil)
                 super(version)
@@ -157,20 +167,20 @@ module Twilio
                     'call_feedback_count' => payload['call_feedback_count'].to_i,
                     'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
                     'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
-                    'end_date' => Twilio.deserialize_iso8601_datetime(payload['end_date']),
+                    'end_date' => Twilio.deserialize_iso8601_date(payload['end_date']),
                     'include_subaccounts' => payload['include_subaccounts'],
                     'issues' => payload['issues'],
                     'quality_score_average' => payload['quality_score_average'].to_f,
                     'quality_score_median' => payload['quality_score_median'].to_f,
                     'quality_score_standard_deviation' => payload['quality_score_standard_deviation'].to_f,
                     'sid' => payload['sid'],
-                    'start_date' => Twilio.deserialize_iso8601_datetime(payload['start_date']),
+                    'start_date' => Twilio.deserialize_iso8601_date(payload['start_date']),
                     'status' => payload['status'],
                 }
 
                 # Context
                 @instance_context = nil
-                @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid']}
+                @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
               end
 
               ##
@@ -179,105 +189,105 @@ module Twilio
               # @return [FeedbackSummaryContext] FeedbackSummaryContext for this FeedbackSummaryInstance
               def context
                 unless @instance_context
-                  @instance_context = FeedbackSummaryContext.new(@version, @params['account_sid'], @params['sid'])
+                  @instance_context = FeedbackSummaryContext.new(@version, @params['account_sid'], @params['sid'], )
                 end
                 @instance_context
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The unique sid that identifies this account
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The call_count
+              # @return [String] The total number of calls
               def call_count
                 @properties['call_count']
               end
 
               ##
-              # @return [String] The call_feedback_count
+              # @return [String] The total number of calls with a feedback entry
               def call_feedback_count
                 @properties['call_feedback_count']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The date this resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The date this resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [Time] The end_date
+              # @return [Date] The latest feedback entry date in the summary
               def end_date
                 @properties['end_date']
               end
 
               ##
-              # @return [Boolean] The include_subaccounts
+              # @return [Boolean] Whether the feedback summary includes subaccounts
               def include_subaccounts
                 @properties['include_subaccounts']
               end
 
               ##
-              # @return [String] The issues
+              # @return [Array[Hash]] Issues experienced during the call
               def issues
                 @properties['issues']
               end
 
               ##
-              # @return [String] The quality_score_average
+              # @return [String] The average QualityScore of the feedback entries
               def quality_score_average
                 @properties['quality_score_average']
               end
 
               ##
-              # @return [String] The quality_score_median
+              # @return [String] The median QualityScore of the feedback entries
               def quality_score_median
                 @properties['quality_score_median']
               end
 
               ##
-              # @return [String] The quality_score_standard_deviation
+              # @return [String] The standard deviation of the quality scores
               def quality_score_standard_deviation
                 @properties['quality_score_standard_deviation']
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] A string that uniquely identifies this feedback entry
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [Time] The start_date
+              # @return [Date] The earliest feedback entry date in the summary
               def start_date
                 @properties['start_date']
               end
 
               ##
-              # @return [feedback_summary.Status] The status
+              # @return [feedback_summary.Status] The status of the feedback summary
               def status
                 @properties['status']
               end
 
               ##
-              # Fetch a FeedbackSummaryInstance
+              # Fetch the FeedbackSummaryInstance
               # @return [FeedbackSummaryInstance] Fetched FeedbackSummaryInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the FeedbackSummaryInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the FeedbackSummaryInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end